py-epg

py-epg is an easy to use, modular, multi-process EPG grabber written in Python.

• 📺 Scrapes various TV Program websites and saves programs in XMLTV format.
• 🧩 Simply extend EpgScraper to grab EPG from your favorite TV site (requires basic Python skills).
• 🤖 The framework provides the rest:
  • Beautiful Soup - easily search & extract data from html elements
  • multi-processing
  • config management
  • logging
  • build & write XMLTV (with auto-generated fields, eg 'stop')
  • single proxy or rotating proxy pool support (with remote proxy-list fetching, per-request rotation, timeouts, retries and a circuit breaker that auto-disables failing proxies)
  • persistent caching (SQLite) of slow-changing data (channel logos, program details) with configurable TTLs
  • auto http/s retries
  • random fake user_agents
• 🚀 Save time by fetching channels in parallel (caution: use proxy server(s) to avoid getting blacklisted)!
• 🧑🏻‍💻 Your contributions are welcome! Feel free to create a PR with your tv-site scraper and/or framework improvements.

Usage

1. Install package:

   $ pip3 install py_epg
   

2. Create configuration: py_epg.xml

   • Add all your channels (see sample config).
   • Make sure there is a corresponding site scraper implementation in py_epg/scrapers for each channels ('site' attribute).
   • Optionally configure a <cache> (persistent caching with TTLs) and a <proxy-list> (rotating proxy pool with circuit breaker) - see the comments in the sample config for all supported attributes.

3. Run:

   $ python3 -m py_epg -c </path/to/your/py_epg.xml> -p
   

   ..or see all supported flags:

   $ python3 -m py_epg -h
   usage: py_epg [-h] [-p [PROGRESS_BAR]] [-q [QUIET]] -c CONFIG
   ...
   

Development

Your contributions are welcome! Setup your dev environment as described below. VSCode is a great free IDE for python projects. Once you are ready with your cool tv site scraper or framework feature, feel free to open a Pull Request here.

1. Install poetry:

   curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
   

2. Clone repository & install dependencies:

   git clone https://github.com/szab100/py-epg.git && cd py-epg
   

3. Configure py_epg.xml

   • Add all your channels (see the sample config xml). Make sure you have a scraper implementation in py_epg/scrapers/ for each channels ('site' attribute).

4. Run:

   poetry install
   poetry run epg -c py_epg.xml
   

License

Copyright 2021. Released under the MIT license.