Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iptv-org/epg
Utilities for downloading the EPG (Electronic Program Guide) for thousands of TV channels from hundreds of sources.
https://github.com/iptv-org/epg
epg guide iptv tv xml
Last synced: 27 days ago
JSON representation
Utilities for downloading the EPG (Electronic Program Guide) for thousands of TV channels from hundreds of sources.
- Host: GitHub
- URL: https://github.com/iptv-org/epg
- Owner: iptv-org
- License: unlicense
- Created: 2021-03-13T17:30:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T15:34:01.000Z (28 days ago)
- Last Synced: 2024-10-14T17:30:47.644Z (28 days ago)
- Topics: epg, guide, iptv, tv, xml
- Language: HTML
- Homepage: https://iptv-org.github.io/
- Size: 40.9 MB
- Stars: 1,813
- Watchers: 74
- Forks: 201
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# EPG
Tools for downloading the EPG (Electronic Program Guide) for thousands of TV channels from hundreds of sources.
## Table of contents
- ✨ [Installation](#installation)
- 🚀 [Usage](#usage)
- 💫 [Update](#update)
- 📺 [Playlists](#playlists)
- 🗄 [Database](#database)
- 👨💻 [API](#api)
- 📚 [Resources](#resources)
- 💬 [Discussions](#discussions)
- 🛠 [Contribution](#contribution)
- 📄 [License](#license)
## Installation
First, you need to install [Node.js](https://nodejs.org/en) on your computer. You will also need to install [Git](https://git-scm.com/downloads) to follow these instructions.
After that open the [Console](https://en.wikipedia.org/wiki/Windows_Console) (or [Terminal]() if you have macOS) and type the following command:
```sh
git clone --depth 1 -b master https://github.com/iptv-org/epg.git
```
Then navigate to the downloaded `epg` folder:
```sh
cd epg
```
And install all the dependencies:
```sh
npm install
```
## Usage
To start the download of the guide, select one of the [supported sites](SITES.md) and paste its name into the command below:
```sh
npm run grab -- --site=example.com
```
And once the download is complete, the guide will be saved to the `guide.xml` file.
```sh
Usage: npm run grab -- [options]
Options:
-s, --site Name of the site to parse
-c, --channels Path to *.channels.xml file (required if the "--site" attribute is
not specified)
-o, --output Path to output file (default: "guide.xml")
-l, --lang Filter channels by language (ISO 639-2 code)
-t, --timeout Override the default timeout for each request
-d, --delay Override the default delay between request
--days Override the number of days for which the program will be loaded
(defaults to the value from the site config)
--maxConnections Limit on the number of concurrent requests (default: 1)
--cron Schedule a script run (example: "0 0 * * *")
--gzip Create a compressed version of the guide as well (default: false)
```
### Access the guide by URL
You can make the guide available via URL by running your own server:
```sh
npm run serve
```
After that, the guide will be available at the link:
```
http://localhost:3000/guide.xml
```
In addition it will be available to other devices on the same local network at the address:
```
http://:3000/guide.xml
```
### Parallel downloading
By default, the guide for each channel is downloaded one by one, but you can change this behavior by increasing the number of simultaneous requests using the `--maxConnections` attribute:
```sh
npm run grab -- --site=example.com --maxConnections=10
```
But be aware that under heavy load, some sites may start return an error or completely block your access.
### Use custom channel list
Create an XML file and copy the descriptions of all the channels you need from the [/sites](sites) into it:
```xml
Arirang TV
...
```
And then specify the path to that file via the `--channels` attribute:
```sh
npm run grab -- --channels=path/to/custom.channels.xml
```
### Run on schedule
If you want to download the guide automatically on a schedule, you need to pass a valid [cron expression](https://crontab.guru/) to the script using the `--cron` attribute:
```sh
npm run grab -- --site=example.com --cron="0 0 * * *"
```
## Update
If you have downloaded the repository code according to the instructions above, then to update it will be enough to run the command:
```sh
git pull
```
And then update all the dependencies:
```sh
npm install
```
## Playlists
Playlists with already linked guides can be found in the [iptv-org/iptv](https://github.com/iptv-org/iptv) repository.
## Database
All channel data is taken from the [iptv-org/database](https://github.com/iptv-org/database) repository. If you find any errors please open a new [issue](https://github.com/iptv-org/database/issues) there.
## API
The API documentation can be found in the [iptv-org/api](https://github.com/iptv-org/api) repository.
## Resources
Links to other useful IPTV-related resources can be found in the [iptv-org/awesome-iptv](https://github.com/iptv-org/awesome-iptv) repository.
## Discussions
If you have a question or an idea, you can post it in the [Discussions](https://github.com/orgs/iptv-org/discussions) tab.
## Contribution
Please make sure to read the [Contributing Guide](https://github.com/iptv-org/epg/blob/master/CONTRIBUTING.md) before sending [issue](https://github.com/iptv-org/epg/issues) or a [pull request](https://github.com/iptv-org/epg/pulls).
And thank you to everyone who has already contributed!
### Backers
### Contributors
## License
[](LICENSE)