Merge branch 'develop'

MANIFEST.in

@@ -1,4 +1,3 @@
 include requirements.txt
 include requirements_test.txt
-exclude *.egg-info
 

README.md

@@ -13,10 +13,14 @@ Other features:
 + Quick fetching of initial chat data by generating continuation params
 instead of web scraping.
 
+For more detailed information, see [wiki](https://github.com/taizan-hokuto/pytchat/wiki)
+
 ## Install
 ```python
 pip install pytchat
 ```
+## Demo
+![demo](https://taizan-hokuto.github.io/statics/demo.gif "demo")
 
 ## Examples
 ### on-demand mode
@@ -133,7 +137,12 @@ Structure of each item which got from items() function.
   <tr>
     <td>currency</td>
     <td>str</td>
-    <td>ex. "USD"</td>
+    <td>ISO 4217 currency codes (ex. "USD")</td>
+  </tr>
+  <tr>
+    <td>bgColor</td>
+    <td>int</td>
+    <td>RGB Int</td>
   </tr>
   <tr>
     <td>author</td>

pytchat/__init__.py

@@ -2,7 +2,7 @@
 pytchat is a python library for fetching youtube live chat.
 """
 __copyright__    = 'Copyright (C) 2019 taizan-hokuto'
-__version__      = '0.0.1.9'
+__version__      = '0.0.2.2'
 __license__      = 'MIT'
 __author__       = 'taizan-hokuto'
 __author_email__ = '55448286+taizan-hokuto@users.noreply.github.com'
@@ -13,6 +13,7 @@ __all__ = ["core_async","core_multithread","processors"]
 from .api import (
     LiveChat,
     LiveChatAsync,
+    ChatProcessor,
     CompatibleProcessor, 
     SimpleDisplayProcessor,
     JsonfileArchiveProcessor

pytchat/api.py

@@ -1,5 +1,6 @@
 from .core_async.livechat import LiveChatAsync
 from .core_multithread.livechat import LiveChat
+from .processors.chat_processor import ChatProcessor
 from .processors.default.processor import DefaultProcessor
 from .processors.compatible.processor import CompatibleProcessor
 from .processors.simple_display_processor import SimpleDisplayProcessor

pytchat/core_async/buffer.py

@@ -2,7 +2,7 @@
 import asyncio
 class Buffer(asyncio.Queue):
     '''
-    チャットデータを格納するバッファの役割を持つLIFOキュー
+    チャットデータを格納するバッファの役割を持つFIFOキュー
 
     Parameter
     ---------

pytchat/core_async/livechat.py

@@ -1,4 +1,4 @@
-import aiohttp, asyncio, async_timeout
+import aiohttp, asyncio
 import datetime
 import json
 import random

pytchat/core_multithread/buffer.py

@@ -3,7 +3,7 @@ import queue
 
 class Buffer(queue.Queue):
     '''
-    チャットデータを格納するバッファの役割を持つLIFOキュー
+    チャットデータを格納するバッファの役割を持つFIFOキュー
 
     Parameter
     ---------

pytchat/processors/chat_processor.py

@@ -5,11 +5,12 @@ class ChatProcessor:
     '''
     def process(self, chat_components: list):
         '''
-        チャットデータの加工を表すインターフェース
-        Listenerから呼び出される。        
+        チャットデータの加工を表すインターフェース。
+        LiveChatオブジェクトから呼び出される。 
+               
         Parameter
         ----------
-        chat_components: list<component>
+        chat_components: [LIST:component]
             component : dict {
                 "video_id" : str
                     動画ID

pytchat/processors/default/renderer/currency.py

@@ -23,7 +23,7 @@ symbols = {
     "PLN\xa0": {"fxtext": "PLN", "jptext": "ポーランド・ズロチ"},
     "R$": {"fxtext": "BRL", "jptext": "ブラジル・レアル"},
     "RUB\xa0": {"fxtext": "RUB", "jptext": "ロシア・ルーブル"},
-    "SEK\xa0": {"fxtext": "SEK", "jptext": "スウェーデン・クローネ"},
+    "SEK\xa0": {"fxtext": "SEK", "jptext": "スウェーデン・クローナ"},
     "£": {"fxtext": "GBP", "jptext": "英・ポンド"},
     "₩": {"fxtext": "KRW", "jptext": "韓国・ウォン"},
     "€": {"fxtext": "EUR", "jptext": "欧・ユーロ"},

setup.py

@@ -31,16 +31,6 @@ assert url
 with open('README.md', encoding='utf-8') as f:
     long_description = f.read()
 
-class CleanCommand(Command):
-    """Custom clean command to tidy up the project root."""
-    user_options = []
-    def initialize_options(self):
-        pass
-    def finalize_options(self):
-        pass
-    def run(self):
-        #system('rm -vrf ./build ./dist ./*.pyc ./*.tgz ./*.egg-info')
-        system('rmdir /Q /S pytchat.egg-info, dist')
 
 
 setup(
@@ -68,7 +58,5 @@ setup(
         'License :: OSI Approved :: MIT License',
     ],
     keywords='youtube livechat asyncio',
-    cmdclass={
-        'clean': CleanCommand,
-    }
+
 )