Merge branch 'release/v0.0.6.4'

Author: taizan-hokuto

README.md

@@ -22,10 +22,23 @@ For more detailed information, see [wiki](https://github.com/taizan-hokuto/pytch
 ```python
 pip install pytchat
 ```
-## Demo
-![demo](https://taizan-hokuto.github.io/statics/demo.gif "demo")
-
 ## Examples
+
+### CLI
+
+One-liner command.
+Save chat data to html.
+
+```bash
+$ pytchat -v ZJ6Q4U_Vg6s -o "c:/temp/"
+
+# options:
+#  -v : video_id
+#  -o : output directory (default path: './')
+# saved filename is [video_id].html
+```
+
+
 ### on-demand mode
 ```python
 from pytchat import LiveChat
@@ -263,6 +276,15 @@ Structure of author object.
 
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 
+
+## Contributes
+Great thanks:
+
+Most of source code of CLI refer to:
+
+[PetterKraabol / Twitch-Chat-Downloader](https://github.com/PetterKraabol/Twitch-Chat-Downloader)
+
+
 ## Author
 
 [taizan-hokuto](https://github.com/taizan-hokuto)

pytchat/__init__.py

@@ -2,7 +2,7 @@
 pytchat is a python library for fetching youtube live chat without using yt api, Selenium, or BeautifulSoup.
 """
 __copyright__    = 'Copyright (C) 2019 taizan-hokuto'
-__version__      = '0.0.6.3'
+__version__      = '0.0.6.4'
 __license__      = 'MIT'
 __author__       = 'taizan-hokuto'
 __author_email__ = '55448286+taizan-hokuto@users.noreply.github.com'
@@ -11,6 +11,7 @@
 __all__ = ["core_async","core_multithread","processors"]
 
 from .api import (
+    cli,
     config,
     LiveChat,
     LiveChatAsync,
@@ -19,6 +20,8 @@
     DummyProcessor,
     DefaultProcessor,
     Extractor, 
+    HTMLArchiver,
+    TSVArchiver,
     JsonfileArchiver,
     SimpleDisplayProcessor,
     SpeedCalculator,

pytchat/api.py

@@ -1,10 +1,13 @@
+from . import cli
 from . import config
 from .core_multithread.livechat import LiveChat
 from .core_async.livechat import LiveChatAsync
 from .processors.chat_processor import ChatProcessor
 from .processors.compatible.processor import CompatibleProcessor
 from .processors.default.processor import DefaultProcessor
 from .processors.dummy_processor import DummyProcessor
+from .processors.html_archiver import HTMLArchiver
+from .processors.tsv_archiver import TSVArchiver
 from .processors.jsonfile_archiver import JsonfileArchiver
 from .processors.simple_display_processor import SimpleDisplayProcessor
 from .processors.speed.calculator import SpeedCalculator

pytchat/cli/__init__.py

@@ -0,0 +1,51 @@
+import argparse
+import os
+from pathlib import Path
+from typing import List, Callable
+from .arguments import Arguments
+
+from .. exceptions import InvalidVideoIdException, NoContentsException
+from .. processors.tsv_archiver import TSVArchiver
+from .. processors.html_archiver import HTMLArchiver
+from .. tool.extract.extractor import Extractor
+from .. tool.videoinfo import VideoInfo
+from .. import __version__
+
+'''
+Most of CLI modules refer to 
+Petter Kraabøl's Twitch-Chat-Downloader
+https://github.com/PetterKraabol/Twitch-Chat-Downloader
+(MIT License)
+
+'''
+def main():
+    # Arguments 
+    parser = argparse.ArgumentParser(description=f'pytchat v{__version__}')
+    parser.add_argument('-v', f'--{Arguments.Name.VIDEO}', type=str,
+         help='Video IDs separated by commas without space')
+    parser.add_argument('-o', f'--{Arguments.Name.OUTPUT}', type=str,
+         help='Output directory (end with "/")', default='./')
+    parser.add_argument(f'--{Arguments.Name.VERSION}', action='store_true',
+         help='Settings version')
+    Arguments(parser.parse_args().__dict__)
+    if Arguments().print_version:
+        print(f'pytchat v{__version__}')
+        return
+
+    # Extractor
+    if Arguments().video_ids:
+        for video_id in Arguments().video_ids:
+            try:
+                info = VideoInfo(video_id)
+                print(f"Extracting...\n"
+                      f" video_id: {video_id}\n"
+                      f" channel:  {info.get_channel_name()}\n"
+                      f" title:    {info.get_title()}")
+                Extractor(video_id, 
+                  processor = HTMLArchiver(Arguments().output+video_id+'.html')
+                ).extract()
+                print("Extraction end.\n")
+            except (InvalidVideoIdException, NoContentsException) as e:
+                print(e)
+        return
+    parser.print_help()

pytchat/cli/arguments.py

@@ -0,0 +1,39 @@
+from typing import Optional, Dict, Union, List
+from .singleton import Singleton
+
+'''
+This modules refer to 
+Petter Kraabøl's Twitch-Chat-Downloader
+https://github.com/PetterKraabol/Twitch-Chat-Downloader
+(MIT License)
+'''
+
+class Arguments(metaclass=Singleton):
+    """
+    Arguments singleton
+    """
+
+    class Name:
+        VERSION: str = 'version'
+        OUTPUT: str = 'output'
+        VIDEO: str = 'video'
+
+    def __init__(self, 
+        arguments: Optional[Dict[str, Union[str, bool, int]]] = None):
+        """
+        Initialize arguments
+        :param arguments: Arguments from cli 
+        (Optional to call singleton instance without parameters)
+        """
+
+        if arguments is None:
+            print('Error: arguments were not provided')
+            exit()
+
+        self.print_version: bool = arguments[Arguments.Name.VERSION]
+        self.output: str = arguments[Arguments.Name.OUTPUT]
+        self.video_ids: List[int] = []
+        # Videos
+        if arguments[Arguments.Name.VIDEO]:
+            self.video_ids = [video_id 
+                for video_id in arguments[Arguments.Name.VIDEO].split(',')]

pytchat/cli/singleton.py

@@ -0,0 +1,19 @@
+'''
+This modules refer to 
+Petter Kraabøl's Twitch-Chat-Downloader
+https://github.com/PetterKraabol/Twitch-Chat-Downloader
+(MIT License)
+'''
+class Singleton(type):
+    """
+    Abstract class for singletons
+    """
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__call__(*args, **kwargs)
+        return cls._instances[cls]
+
+    def get_instance(cls, *args, **kwargs):
+        cls.__call__(*args, **kwargs)

pytchat/config/mylogger.py

@@ -1,6 +1,6 @@
 from logging import NullHandler, getLogger, StreamHandler, FileHandler, Formatter
 import logging
-import datetime
+from datetime import datetime
 
 
 def get_logger(modname,loglevel=logging.DEBUG):
@@ -28,5 +28,11 @@ def get_logger(modname,loglevel=logging.DEBUG):
 
 class MyFormatter(logging.Formatter):
     def format(self, record):
-        s =(datetime.datetime.fromtimestamp(record.created)).strftime("%m-%d %H:%M:%S")+'| '+ (record.module).ljust(15)+(' { '+record.funcName).ljust(20) +":"+str(record.lineno).rjust(4)+'} - '+record.getMessage()
-        return s
+        timestamp = (
+            datetime.fromtimestamp(record.created)).strftime("%m-%d %H:%M:%S")
+        module = (record.module).ljust(15)
+        funcname = (record.funcName).ljust(18)
+        lineno = str(record.lineno).rjust(4)
+        message = record.getMessage()
+
+        return timestamp+'| '+module+' { '+funcname+':'+lineno+'} - '+message