Metadata-Version: 2.1
Name: pyepggrab
Version: 0.1.dev1
Summary: Drop in replacement/extension to xmltv grabbers
Project-URL: Documentation, https://github.com/pyepggrab/pyepggrab#readme
Project-URL: Issues, https://github.com/pyepggrab/pyepggrab/issues
Project-URL: Source, https://github.com/pyepggrab/pyepggrab
License-Expression: MIT
License-File: LICENSE.txt
Keywords: XMLTV,epg,tv
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Requires-Dist: backports-zoneinfo; python_version < '3.9'
Requires-Dist: beautifulsoup4
Requires-Dist: extruct
Requires-Dist: fake-useragent
Requires-Dist: lxml
Requires-Dist: requests
Requires-Dist: roman
Requires-Dist: typing-extensions; python_version < '3.12'
Requires-Dist: urllib3
Provides-Extra: develop
Requires-Dist: black; extra == 'develop'
Requires-Dist: hatch; extra == 'develop'
Requires-Dist: mypy; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Description-Content-Type: text/markdown

# pyepggrab

Extension / replacement of the original [XMLTV][xmltv].

All grabbers are written following the XMLTV specifications and compatible 
with all XMLTV tools (`tv_find_grabbers`, `tv_validate_*`).

Grabbers found here can be used together with the grabbers found in the
original XMLTV project, and any software uses the original XMLTV project
can use these grabbers without any modification.

To avoid name conflicts, pyepggrab grabbers use the prefix `tv_grab_pyepg_`.

## Installation

Currently, there are no premade packages available, but this expected to change
in the future.

If the functionality of `tv_find_grabbers` is required the one in the
original [XMLTV][xmltv] project can be used until we provide an alternative.
(On the [Roadmap](#roadmap))

To install from source, create a wheel package (this requires `hatch`):

> `hatch build`

and install it with your preferred package manager (`pipx` in the example):

> `pipx install dist/pyepggrab-*.whl`

## Available grabbers:

| Country | Guide source      | Grabber                |
|:-------:|-------------------|------------------------|
| HU      | [port.hu][porthu] | [hu_porthu][hu_porthu] |

[porthu]: https://port.hu
[hu_porthu]: pyepggrab/grabbers/hu_porthu

## Roadmap

In no particular order

- [ ] Upload a package to PyPi
- [ ] Write an example grabber to demonstrate the usage of pyepggrab
- [ ] Write tools to make it standalone (`tv_find_grabbers`, `tv_validate_*`)

[xmltv]: https://github.com/XMLTV/xmltv