Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 3.47 KB

README.md

File metadata and controls

79 lines (63 loc) · 3.47 KB
Raw

Chat Downloader

A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!

Python PyPI version Downloads GitHub license

Installation

Install using pip

pip install chat-downloader

To update to the latest version, add the --upgrade flag to the above command.

Install using git

git clone https://github.com/xenova/chat-downloader.git
cd chat-downloader
python setup.py install

Usage

Chat items are parsed into JSON objects (a.k.a. dictionaries). For a comprehensive, documented list of included fields, consult the Chat Item Wiki.

Command line:

chat_downloader https://www.youtube.com/watch?v=5qap5aO4i9A

For advanced command line use-cases and examples, consult the Command Line Wiki.

Python:

from chat_downloader import ChatDownloader

url = 'https://www.youtube.com/watch?v=5qap5aO4i9A'
chat = ChatDownloader().get_chat(url)       # create a generator
for message in chat:                        # iterate over messages
    print(chat.format(message))             # print the formatted message

For advanced python use-cases and examples, consult the Python Wiki.

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.

Contributing

If you want to contribute to chat-downloader, be sure to follow the contribution guidelines.

Supported sites:

  • YouTube.com - Livestreams, past broadcasts and premieres.
  • Twitch.tv - Livestreams, past broadcasts and clips.
  • Facebook.com (currently in development) - Livestreams and past broadcasts.

TODO list:

  • Finalise unit testing
  • Improve documentation
  • Add progress bar when duration is known
  • Add support for streams by username (i.e. currently live)
  • Websites to add:
    • facebook.com (in progress)
    • vimeo.com
    • dlive.tv
    • instagib.tv
    • dailymotion.com
    • reddit live
    • younow.com
  • Add --statistics tag. This will show a summary of all chat messages retrieved (e.g. sum YouTube superchat, memberships, subscriptions, etc.)