A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!
Project description
Chat Downloader
A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!
Requirements:
- Python 3.
- Run
pip install chat_replay_downloader
to install the package.
Command line:
Usage
usage: chat_replay_downloader [-h] [--start_time START_TIME]
[--end_time END_TIME]
[--message_types MESSAGE_TYPES | --message_groups MESSAGE_GROUPS]
[--max_attempts MAX_ATTEMPTS]
[--retry_timeout RETRY_TIMEOUT]
[--max_messages MAX_MESSAGES]
[--inactivity_timeout INACTIVITY_TIMEOUT]
[--timeout TIMEOUT] [--format FORMAT]
[--format_file FORMAT_FILE]
[--chat_type {live,top}]
[--message_receive_timeout MESSAGE_RECEIVE_TIMEOUT]
[--buffer_size BUFFER_SIZE] [--output OUTPUT]
[--sort_keys] [--indent INDENT] [--overwrite]
[--pause_on_debug PAUSE_ON_DEBUG]
[--logging {none,debug,info,warning,error,critical} | --testing | --verbose]
[--cookies COOKIES]
url
A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!
Mandatory Arguments:
url The URL of the livestream, video, clip or past broadcast
General Arguments:
-h, --help show this help message and exit
Timing Arguments:
--start_time START_TIME, -s START_TIME
Start time in seconds or hh:mm:ss, default is None (as early as possible)
--end_time END_TIME, -e END_TIME
End time in seconds or hh:mm:ss, default is None (until the end)
Message Type Arguments:
--message_types MESSAGE_TYPES
List of messages types to include
--message_groups MESSAGE_GROUPS
List of messages groups (a predefined, site-specific collection of message types) to include
Retry Arguments:
--max_attempts MAX_ATTEMPTS
Maximum number of attempts to retrieve chat messages
--retry_timeout RETRY_TIMEOUT
Number of seconds to wait before retrying. Setting this to a negative number will wait for user input.
Default is None (use exponential backoff, i.e. immediate, 1s, 2s, 4s, 8s, ...)
Termination Arguments:
--max_messages MAX_MESSAGES
Maximum number of messages to retrieve, default is None (unlimited)
--inactivity_timeout INACTIVITY_TIMEOUT
Stop getting messages after not receiving anything for a certain duration (in seconds)
--timeout TIMEOUT Stop retrieving chat after a certain duration (in seconds)
Format Arguments:
--format FORMAT Specify how messages should be formatted for printing, default uses site default
--format_file FORMAT_FILE
Specify the format file to choose formats from
[Site Specific] YouTube Arguments:
--chat_type {live,top}
Specify chat type, default is live
[Site Specific] Twitch Arguments:
--message_receive_timeout MESSAGE_RECEIVE_TIMEOUT
Time before requesting for new messages
--buffer_size BUFFER_SIZE
Specify a buffer size for retrieving messages
Output Arguments:
--output OUTPUT, -o OUTPUT
Path of the output file, default is None (i.e. print to standard output)
--sort_keys Sort keys when outputting to a file
--indent INDENT Number of spaces to indent JSON objects by. If nonnumerical input is provided, this will be used to indent the objects.
--overwrite Overwrite output file if it exists. Otherwise, append to the end of the file.
Debugging/Testing Arguments:
--pause_on_debug PAUSE_ON_DEBUG
Pause on certain debug messages
--logging {none,debug,info,warning,error,critical}
Level of logging to display
--testing Enable testing mode
--verbose, -v Print various debugging information. This is equivalent to setting logging to debug
Initialisation Arguments:
--cookies COOKIES, -c COOKIES
Path of cookies file
TODO
- Set up unit testing
- Improve documentation
Examples
(Coming soon)
======= History
0.0.1 (2020-12-01)
- First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for chat_replay_downloader-0.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 768994ad35f67b8c6421a601209126b8ac998cb78492d8d8903d6c93a8934542 |
|
MD5 | ff5b58c414ab6a75a646b6172f5a8dc8 |
|
BLAKE2b-256 | cc15727d62a489cf99d314d46bb1ff89803924402640e9b17f007ed93b2f6ac9 |
Close
Hashes for chat_replay_downloader-0.0.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 926de77218d07520ab81df9220e3d6955654f5c38e52737093dcfe72ca084a28 |
|
MD5 | e3d97abe18bc02b47bc699c3f3bdea87 |
|
BLAKE2b-256 | 54e4b50908f5f8db547f8c66b341636b6691a1f9bc5d1abde5f8deb4e2f077f4 |