Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xenova/chat-downloader
A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!
https://github.com/xenova/chat-downloader
chat livestream python twitch youtube zoom
Last synced: 3 days ago
JSON representation
A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!
- Host: GitHub
- URL: https://github.com/xenova/chat-downloader
- Owner: xenova
- License: mit
- Created: 2020-07-24T00:32:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T00:42:32.000Z (6 months ago)
- Last Synced: 2025-01-09T07:04:25.753Z (10 days ago)
- Topics: chat, livestream, python, twitch, youtube, zoom
- Language: Python
- Homepage: https://chat-downloader.readthedocs.io/
- Size: 4.15 MB
- Stars: 974
- Watchers: 26
- Forks: 138
- Open Issues: 58
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-twitch-dev - xenova/chat-downloader - Simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. (Libraries / Python)
README
..
TODO
- temp move ... move back to root
- auto-generate using other rst files
***************
Chat Downloader
***************
.. image:: https://img.shields.io/pypi/pyversions/chat-downloader
:target: https://pypi.org/project/chat-downloader
:alt: Python
.. image:: https://img.shields.io/pypi/v/chat-downloader.svg
:target: https://pypi.org/project/chat-downloader
:alt: PyPI version
.. image:: https://pepy.tech/badge/chat-downloader/month
:target: https://pypi.org/project/chat-downloader
:alt: Downloads
.. image:: https://img.shields.io/github/license/xenova/chat-downloader
:target: https://github.com/xenova/chat-downloader/blob/master/LICENSE
:alt: License
.. image:: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fxenova%2Fchat-downloader%2Fmaster%2Fdocs%2F_dynamic%2Fcoverage.json
:target: https://pypi.org/project/chat-downloader
:alt: Coverage
..
[](https://badge.fury.io/py/chat-downloader)
[](https://badge.fury.io/py/chat-downloader)
[](https://badge.fury.io/py/chat-downloader)
[](https://github.com/xenova/chat-downloader/releases)
`Chat Downloader`_ is a simple tool used to retrieve chat messages from livestreams,
videos, clips and past broadcasts. No authentication needed!
.. _Chat Downloader: https://github.com/xenova/chat-downloader
############
Installation
############
This tool is distributed on PyPI_ and can be installed with ``pip``:
.. _PyPI: https://pypi.org/project/chat-downloader/
.. code:: console
$ pip install chat-downloader
To update to the latest version, add the ``--upgrade`` flag to the above command.
Alternatively, the tool can be installed with ``git``:
.. code:: console
$ git clone https://github.com/xenova/chat-downloader.git
$ cd chat-downloader
$ python setup.py install
#####
Usage
#####
Command line
------------
.. code:: console
usage: chat_downloader [-h] [--version] [--start_time START_TIME]
[--end_time END_TIME]
[--message_types MESSAGE_TYPES | --message_groups MESSAGE_GROUPS]
[--max_attempts MAX_ATTEMPTS]
[--retry_timeout RETRY_TIMEOUT]
[--interruptible_retry [INTERRUPTIBLE_RETRY]]
[--max_messages MAX_MESSAGES]
[--inactivity_timeout INACTIVITY_TIMEOUT]
[--timeout TIMEOUT] [--format FORMAT]
[--format_file FORMAT_FILE] [--chat_type {live,top}]
[--ignore IGNORE]
[--message_receive_timeout MESSAGE_RECEIVE_TIMEOUT]
[--buffer_size BUFFER_SIZE] [--output OUTPUT]
[--overwrite [OVERWRITE]] [--sort_keys [SORT_KEYS]]
[--indent INDENT] [--pause_on_debug | --exit_on_debug]
[--logging {none,debug,info,warning,error,critical} | --testing | --verbose | --quiet]
[--cookies COOKIES] [--proxy PROXY]
url
For example, to save messages from a livestream to a JSON file, you can use:
.. code:: console
$ chat_downloader https://www.youtube.com/watch?v=jfKfPfyJRdk --output chat.json
For a description of these options, as well as advanced command line use-cases and examples, consult the `Command Line Usage `_ page.
Python
------
.. code:: python
from chat_downloader import ChatDownloader
url = 'https://www.youtube.com/watch?v=jfKfPfyJRdk'
chat = ChatDownloader().get_chat(url) # create a generator
for message in chat: # iterate over messages
chat.print_formatted(message) # print the formatted message
For advanced python use-cases and examples, consult the `Python Documentation `_.
##########
Chat Items
##########
Chat items/messages are parsed into JSON objects (a.k.a. dictionaries) and should follow a format similar to this:
.. code-block::
{
...
"message_id": "xxxxxxxxxx",
"message": "actual message goes here",
"message_type": "text_message",
"timestamp": 1613761152565924,
"time_in_seconds": 1234.56,
"time_text": "20:34",
"author": {
"id": "UCxxxxxxxxxxxxxxxxxxxxxxx",
"name": "username_of_sender",
"images": [
...
],
"badges": [
...
]
},
...
}
For an extensive, documented list of included fields, consult the `Chat Item Fields `_ page.
##########################
Frequently Asked Questions
##########################
*Coming soon*
######
Issues
######
Found a bug or have a suggestion? File an issue `here`_. To assist the
developers in fixing the issue, please follow the issue template as
closely as possible.
.. _here: https://github.com/xenova/chat-downloader/issues/new/choose
############
Contributing
############
If you would like to help improve the tool, you'll find more
information on contributing in our `Contributing Guide `_.
################
Supported sites:
################
- YouTube.com - Livestreams, past broadcasts and premieres.
- Twitch.tv - Livestreams, past broadcasts and clips.
- Zoom.us - Past broadcasts
- Facebook.com (currently in development) - Livestreams and past
broadcasts.
.. _Chat Item Wiki: https://github.com/xenova/chat-downloader/wiki/Item-Template
.. _Command Line Wiki: https://github.com/xenova/chat-downloader/wiki/Command-Line-Usage
.. _Python Wiki: https://github.com/xenova/chat-downloader/wiki/Python-Documentation