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] [--output OUTPUT] [--sort_keys] [--indent INDENT] [--overwrite]
[--pause_on_debug PAUSE_ON_DEBUG] [--logging {none,debug,info,warning,error,critical} | --testing | --verbose] [--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] [--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
--end_time END_TIME, -e END_TIME
End time in seconds or hh:mm:ss
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
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
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
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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 229e4af2cbfa2c1dd73a5aec92a04f72c40a5ca997fa490d72155edd78ab71a2 |
|
MD5 | c9bbba142e76f1cc2baedd73d9f13da9 |
|
BLAKE2b-256 | 07fa3a43f51d4cc6a97289787c50d7767d6206116dd6c1d90286f8968ba2b2d5 |
Close
Hashes for chat_replay_downloader-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c65c0b3c75a8c8a88f3ee6911d38cc610abb2ea518ab3aabf45b04427add041d |
|
MD5 | 019297e466fc004ab9e4243c27760fbb |
|
BLAKE2b-256 | 063e0c9c9148911762cfc15b126defc58ab0576316d2eec8bf8fab995df24fe8 |