Skip to content

Latest commit

 

History

History
104 lines (66 loc) · 5.09 KB

README.md

File metadata and controls

104 lines (66 loc) · 5.09 KB

Tvheadend IPTV Config

Tvheadend IPTV Config

Buy Me a Coffee at ko-fi.com

GitHub tag (latest by date) GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests

Docker Stars Docker Pulls Docker Image Size (tag)

GitHub Workflow Status (with branch)

GitHub license

Tvheadend IPTV Config is a simple wrapper around Tvheadend with the singular goal of making it simple to configure Tvheadend for IPTV playlist.

Tvheadend is an extremely powerful TV streaming server and recorder with excellent support for IPTV sources. However, for most people, setting this up can be difficult and time-consuming. The goal of this project is to wrap around Tvheadend and, using its API, configure most of the server for you.

Project Status

This project is currently in beta. I am publishing builds, but the application is very new and could be full of bugs, inefficent processes, or visual blemishes. That being said, if you would like to contribute to this project, feel free to provide a PR.

I will probably not be acknowledging any issue reports or testing. But feel free to also reach out on Discord if you would like to contribute any suggestions there.

Table Of Contents

Dependencies

Install and Run

License

Dependencies

  • NodeJS (Install).
  • Python 3.x (Install).
  • Various Python requirements listed in 'requirements.txt' in the project root.
  • A TVHeadend server
    • Only TVHeadend v4.3+ is tested, though 4.2.8 may work fine.

Install and Run

Development

Run from source with docker compose:

From the project root run:

mkdir -p ./dev_env/config
docker compose -f ./docker/docker-compose.dev-aio.yml up --build

This will create a directory within this project root called ./dev_env which contains all configuration and cache data.

Run from source with a Python venv

To setup a development environment, first setup a Run from source setup.

Then run the project with debugging tools enabled by using the script

./devops/run_local_dev_env.sh

Updating packages

Activate the venv and, from inside the Python venv, run the command:

python3 -m pip install -r ./requirements.txt -r ./requirements-dev.txt

This will install all the current dev dependencies and tools.

Now run the pip-audit check command. This will print any packages that need to be updated.

pip-audit -r ./requirements.txt -r ./requirements-dev.txt

This will give you a printout of what is out of date. From there you can select which packages you wish to upgrade.

Once you have upgraded the packages, run this command to upgrade the frozen requirements.

pip-compile ./requirements.in --upgrade

License

This projected is licensed under the Apache 2.0 Licence.

Copyright (C) Josh Sunnex - All Rights Reserved.