Skip to main content

a python library for fetching youtube live chat.

Project description

pytchat

pytchat is a python library for fetching youtube live chat.

Description

pytchat is a python library for fetching youtube live chat without using youtube api, Selenium or BeautifulSoup.

Other features:

  • Customizable chat data processors including youtube api compatible one.
  • Available on asyncio context.
  • Quick fetching of initial chat data by generating continuation params instead of web scraping.

For more detailed information, see wiki.

Install

pip install pytchat

Demo

demo

Examples

on-demand mode

from pytchat import LiveChat

chat = LiveChat("DSGyEsJ17cI")
while chat.is_alive():
  data = chat.get()
  for c in data.items:
    print(f"{c.datetime} [{c.author.name}]-{c.message} {c.amountString}")
    data.tick()

callback mode

from pytchat import LiveChat
import time

#callback function is automatically called.
def display(data):
  for c in data.items:
    print(f"{c.datetime} [{c.author.name}]-{c.message} {c.amountString}")
    data.tick()

if __name__ == '__main__':
  chat = LiveChat("DSGyEsJ17cI", callback = display)
  while chat.is_alive():
    #other background operation.
    time.sleep(3)

asyncio context:

from pytchat import LiveChatAsync
from concurrent.futures import CancelledError
import asyncio

async def main():
  chat = LiveChatAsync("DSGyEsJ17cI", callback = func)
  while chat.is_alive():
    #other background operation.
    await asyncio.sleep(3)

#callback function is automatically called.
async def func(data):
  for c in data.items:
    print(f"{c.datetime} [{c.author.name}]-{c.message} {c.amountString}")
    await data.tick_async()

if __name__ == '__main__':
  try:
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())
  except CancelledError:
    pass

youtube api compatible processor:

from pytchat import LiveChat, CompatibleProcessor
import time

chat = LiveChat("DSGyEsJ17cI", 
  processor = CompatibleProcessor() )

while chat.is_alive():
  data = chat.get()
  polling = data['pollingIntervalMillis']/1000
  for c in data['items']:
    if c.get('snippet'):
      print(f"[{c['authorDetails']['displayName']}]"
            f"-{c['snippet']['displayMessage']}")
      time.sleep(polling/len(data['items']))

replay:

If specified video is not live, automatically try to fetch archived chat data.

from pytchat import LiveChat

def main():
  #seektime (seconds): start position of chat.
  chat = LiveChat("ojes5ULOqhc", seektime = 60*30)
  print('Replay from 30:00')
  while chat.is_alive():
    data = chat.get()
    for c in data.items:
      print(f"{c.elapsedTime} [{c.author.name}]-{c.message} {c.amountString}")
      data.tick()

if __name__ == '__main__':
  main()

Structure of Default Processor

Each item can be got with items() function.

name type remarks
type str "superChat","textMessage","superSticker","newSponsor"
id str
message str emojis are represented by ":(shortcut text):"
messageEx str list of message texts and emoji URLs.
timestamp int unixtime milliseconds
datetime str e.g. "2019-10-10 12:34:56"
elapsedTime str elapsed time. (e.g. "1:02:27") *Replay Only.
amountValue float e.g. 1,234.0
amountString str e.g. "$ 1,234"
currency str ISO 4217 currency codes (e.g. "USD")
bgColor int RGB Int
author object see below

Structure of author object.

name type remarks
name str
channelId str *chatter's channel ID.
channelUrl str
imageUrl str
badgeUrl str
isVerified bool
isChatOwner bool
isChatSponsor bool
isChatModerator bool

Licence

MIT License

Author

taizan-hokuto

twitter:@taizan205

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

pytchat-0.0.5.0.tar.gz (25.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page