From 6e0d75e32e7813eb8b9c91f8a777d19ddaebcf9e Mon Sep 17 00:00:00 2001 From: David <39565245+dmunozv04@users.noreply.github.com> Date: Wed, 20 Aug 2025 21:34:07 +0200 Subject: [PATCH] Add pypi (pipx, uv) and releases info --- Installation.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 81 insertions(+), 5 deletions(-) diff --git a/Installation.md b/Installation.md index 6e07818..733732f 100644 --- a/Installation.md +++ b/Installation.md @@ -1,15 +1,18 @@ # Docker -There are two basic steps to install iSponsorBlockTV using Docker. Step 1 involves creating a config.json file using the graphical configuation or command-line tools. Step 2 involves creating and running the service via docker compose or run. In both steps, you will need to enter the pathway to your iSponsorBlockTV data directory. Alternatively, you can install iSponsorBlock from the source. +There are two basic steps to install iSponsorBlockTV using Docker. Step 1 involves creating a config.json file using the graphical configuation or command-line tools. Step 2 involves creating and running the service via docker compose or run. In both steps, you will need to enter the pathway to your iSponsorBlockTV data directory. Alternatively, you can install iSponsorBlock from pypi, releases or from source. ## Step 1: Create a config file + Choose one of the following configurators to add devices and configure options. -### Option 1: Using the new graphical configurator tool: +### Option 1: Using the new graphical configurator tool + You can use the graphical setup wizard (powered by [textual](https://github.com/Textualize/textual)). If you want to auto discover your device, you need to run the container with the `--net=host` flag. This only works on linux. Run it with the following command: + ```Shell docker run --rm -it \ -v /PATH_TO_YOUR_DATA_DIR:/app/data \ @@ -18,19 +21,25 @@ docker run --rm -it \ ghcr.io/dmunozv04/isponsorblocktv \ --setup ``` -### Option 2: Using the text-based cli configurator tool: + +### Option 2: Using the text-based cli configurator tool + This is a great option if you experience issues with the graphical configurator Docker users can run it with the following command: + ```Shell docker run --rm -it \ -v /PATH_TO_YOUR_DATA_DIR:/app/data \ ghcr.io/dmunozv04/isponsorblocktv \ --setup-cli ``` + Note, the CLI will ask you for a TV Link Code. You can find this on your Device's Youtube app, by going to Settings -> Link with TV code + ## Step 2: Install and run the iSponsorBlockTV Docker service ### Option 1: Using docker-compose + ```YAML services: iSponsorBlockTV: @@ -54,6 +63,7 @@ After completing setup, use `docker-compose up -d` to start. Run the container with docker run: The container doesn't need the `--net=host` flag anymore, so you can run it like this: + ```Shell docker run -d \ --name iSponsorBlockTV \ @@ -89,14 +99,80 @@ Volume=/etc/containers/config/isponsorblocktv:/app/data Place that in a file at `/etc/containers/systemd/isponsorblocktv.container`, run `systemctl daemon-reload`, and you should now have a systemd service titled `isponsorblocktv` that you can start, stop, and enable/disable the same as any other systemd service. +# From PyPI + +You can install iSponsorBlockTV from PyPI using pipx or uv. This will manage dependencies and allow you to run the program without needing to install Python or any other dependencies manually. + +## Install with uv + +You can install uv from [uv's official documentation](https://docs.astral.sh/uv/getting-started/installation/) +Once you have uv installed, you can install iSponsorBlockTV with the following command: + +```Shell +uv tool install isponsorblocktv +``` + +## Install with pipx + +You can install pipx from [pipx's official documentation](https://pipx.pypa.io/stable/installation/). + +Once you have pipx installed, you can install iSponsorBlockTV with the following command: + +```Shell +pipx install isponsorblocktv +``` + +## Setup + +After installing, you can run the setup command to create a config file. + +### Option 1: Using the new graphical configurator tool: + +You can use the graphical setup wizard (powered by [textual](https://github.com/Textualize/textual)). + +```Shell +isponsorblocktv --setup +``` + +### Option 2: Using the text-based cli configurator tool: + +This is a great option if you experience issues with the graphical configurator. + +```Shell +isponsorblocktv --setup-cli +``` + +## Run iSponsorBlockTV + +After installing iSponsorBlockTV, you can run it using the following command: + +```Shell +isponsorblocktv +``` + +You should create a service using systemd, or another service manager, to run iSponsorBlockTV in the background. There's [an open issue](https://github.com/dmunozv04/iSponsorBlockTV/issues/108) to handle this automatically. + +# From Releases + +You can download the latest release from the [releases page](https://github.com/dmunozv04/iSponsorBlockTV/releases/latest). +Locate the file that matches your system OS and architecture, and download it. The file will be named `isponsorblocktv----`. + +After downloading, you can run the binary directly. Make sure to give it execute permissions if necessary. +You will need to run the setup command to create a config file (see above for instructions). +It's recommended to set up a service using systemd, or another service manager, to run iSponsorBlockTV in the background. + # From source + ## Install + You need to install [python](https://www.python.org/downloads/) version 3.9 or higher first, and to make it available in your PATH. After, clone the repo. -Then you need to download the dependencies with pip: +Then you need to download the dependencies with pip: ```python3 -m pip install -r requirements.txt``` Or ```python -m pip install -r requirements.txt``` Lastly, run ```main.py``` + ## Setup -run ```main.py --setup``` \ No newline at end of file + +run ```main.py --setup```