| Name | pyepggrab JSON |
| Version |
0.1.13
JSON |
| download |
| home_page | None |
| Summary | Drop in replacement/extension to xmltv grabbers |
| upload_time | 2024-03-29 11:23:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
xmltv
epg
tv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
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))
### From package
pyepggrab is available on PyPi: https://pypi.org/project/pyepggrab/
Install it with your preferred package manager.
For example, with `pip`
```
pip install pyepggrab
```
or with `pipx`
```
pipx install pyepggrab
```
### From source
To install from source, create a wheel package (this requires `hatch`):
```
hatch build
```
and install it with your preferred package manager.
For example, with `pip`
```
pip install dist/pyepggrab-*.whl
```
or with `pipx`
```
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
## Standard XMLTV parameters
### All grabbers
- `--capabilities`: capabilities of the grabber (below)
- `--description`: short description of the grabber
- `--help`: list of all parameters that the grabber supports
- `--version`: display the version of the grabber
### Baseline capability
- `--quiet`: no logging output (supported by every grabber)
- `--output`: save the output to a file (default is STDOUT)
- `--days`: Download the specified number of days
- `--offset`: Download from the specified offset (0 = today)
- `--config-file`: use the specified config file
### Manualconfig capability
- `--configure`: run an interactive configuration session
## Pyepggrab specific parameters
### All grabbers
- `--pyepggrabver`: display the version of pyepggrab
- `-q`, `--quiet`: alias for the baseline parameter
- `-l`, `--loglevel`: logging level: FATAL, ERROR, WARNING, INFO, DEBUG
- `-v`, `--verbose`: alias for `--loglevel INFO`
- `-d`, `--debug`: alias for `--loglevel DEBUG`
### Grabber specific parameters
Documented in each grabber's README.
## Roadmap
In no particular order
- [x] Upload a package to PyPi
- [x] Write an example grabber to demonstrate the usage of pyepggrab (see [example](example) directory)
- [ ] Write tools to make it standalone (`tv_find_grabbers`, `tv_validate_*`)
[xmltv]: https://github.com/XMLTV/xmltv
Raw data
{
"_id": null,
"home_page": null,
"name": "pyepggrab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "XMLTV, epg, tv",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/17/0a/0ae7ba0c00700b8edca437d42a98773ac3a433e6f5030eb325f702d39773/pyepggrab-0.1.13.tar.gz",
"platform": null,
"description": "# pyepggrab\n\nExtension / replacement of the original [XMLTV][xmltv].\n\nAll grabbers are written following the XMLTV specifications and compatible \nwith all XMLTV tools (`tv_find_grabbers`, `tv_validate_*`).\n\nGrabbers found here can be used together with the grabbers found in the\noriginal XMLTV project, and any software uses the original XMLTV project\ncan use these grabbers without any modification.\n\nTo avoid name conflicts, pyepggrab grabbers use the prefix `tv_grab_pyepg_`.\n\n## Installation\n\nIf the functionality of `tv_find_grabbers` is required the one in the\noriginal [XMLTV][xmltv] project can be used until we provide an alternative.\n(On the [Roadmap](#roadmap))\n\n### From package\n\npyepggrab is available on PyPi: https://pypi.org/project/pyepggrab/\n\nInstall it with your preferred package manager.\n\nFor example, with `pip`\n```\npip install pyepggrab\n```\n\nor with `pipx`\n```\npipx install pyepggrab\n```\n\n### From source\n\nTo install from source, create a wheel package (this requires `hatch`):\n\n```\nhatch build\n```\n\nand install it with your preferred package manager.\n\nFor example, with `pip`\n```\npip install dist/pyepggrab-*.whl\n```\n\nor with `pipx`\n```\npipx install dist/pyepggrab-*.whl\n```\n\n## Available grabbers:\n\n| Country | Guide source | Grabber |\n|:-------:|-------------------|------------------------|\n| HU | [port.hu][porthu] | [hu_porthu][hu_porthu] |\n\n[porthu]: https://port.hu\n[hu_porthu]: pyepggrab/grabbers/hu_porthu\n\n## Standard XMLTV parameters\n\n### All grabbers\n\n- `--capabilities`: capabilities of the grabber (below)\n- `--description`: short description of the grabber\n- `--help`: list of all parameters that the grabber supports\n- `--version`: display the version of the grabber\n\n### Baseline capability \n\n- `--quiet`: no logging output (supported by every grabber)\n- `--output`: save the output to a file (default is STDOUT)\n- `--days`: Download the specified number of days\n- `--offset`: Download from the specified offset (0 = today)\n- `--config-file`: use the specified config file\n\n### Manualconfig capability \n\n- `--configure`: run an interactive configuration session\n\n## Pyepggrab specific parameters\n\n### All grabbers\n\n- `--pyepggrabver`: display the version of pyepggrab\n- `-q`, `--quiet`: alias for the baseline parameter\n- `-l`, `--loglevel`: logging level: FATAL, ERROR, WARNING, INFO, DEBUG\n- `-v`, `--verbose`: alias for `--loglevel INFO`\n- `-d`, `--debug`: alias for `--loglevel DEBUG`\n\n### Grabber specific parameters\n\nDocumented in each grabber's README.\n\n## Roadmap\n\nIn no particular order\n\n- [x] Upload a package to PyPi\n- [x] Write an example grabber to demonstrate the usage of pyepggrab (see [example](example) directory)\n- [ ] Write tools to make it standalone (`tv_find_grabbers`, `tv_validate_*`)\n\n[xmltv]: https://github.com/XMLTV/xmltv",
"bugtrack_url": null,
"license": null,
"summary": "Drop in replacement/extension to xmltv grabbers",
"version": "0.1.13",
"project_urls": {
"Documentation": "https://github.com/pyepggrab/pyepggrab#readme",
"Issues": "https://github.com/pyepggrab/pyepggrab/issues",
"Source": "https://github.com/pyepggrab/pyepggrab"
},
"split_keywords": [
"xmltv",
" epg",
" tv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "18b68e7f3683ee1d97381cfbf9aa6d19eb0b5b929d491a9edc694656edb28aa1",
"md5": "2944e4c9194162cb6d657ddcb2f883ef",
"sha256": "9725299d2363db5e7b8adad04398f9bf93fea5093bb4d69dd000d627ddbe0520"
},
"downloads": -1,
"filename": "pyepggrab-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2944e4c9194162cb6d657ddcb2f883ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 47280,
"upload_time": "2024-03-29T11:23:10",
"upload_time_iso_8601": "2024-03-29T11:23:10.682224Z",
"url": "https://files.pythonhosted.org/packages/18/b6/8e7f3683ee1d97381cfbf9aa6d19eb0b5b929d491a9edc694656edb28aa1/pyepggrab-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "170a0ae7ba0c00700b8edca437d42a98773ac3a433e6f5030eb325f702d39773",
"md5": "9536a03d0c63fbd51265356e587b0b9f",
"sha256": "5b0de5e273b9814530c13358b7e7347d250d04338fe100850538fb615375e02e"
},
"downloads": -1,
"filename": "pyepggrab-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "9536a03d0c63fbd51265356e587b0b9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 146828,
"upload_time": "2024-03-29T11:23:12",
"upload_time_iso_8601": "2024-03-29T11:23:12.368635Z",
"url": "https://files.pythonhosted.org/packages/17/0a/0ae7ba0c00700b8edca437d42a98773ac3a433e6f5030eb325f702d39773/pyepggrab-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 11:23:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyepggrab",
"github_project": "pyepggrab#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyepggrab"
}
