Skip to content

Commit 088d7d1

Browse files
committed
docs: feature published PyPI package and Docker Hub image
Add PyPI/Docker Hub badges to the README, note 'pip install unit3dprep' in the install guide, and a tip to use the published image (hashdeveloper512/unit3dprep) to skip the local Docker build.
1 parent 5c8d2d3 commit 088d7d1

6 files changed

Lines changed: 22 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ Versioning: [Semantic Versioning](https://semver.org/).
66

77
## [Unreleased]
88

9+
### Changed
10+
- Documentazione: badge PyPI/Docker Hub nel README; guide d'installazione con riferimenti agli
11+
artefatti pubblicati (`pip install unit3dprep`, immagine `hashdeveloper512/unit3dprep`) e tip
12+
per saltare la build Docker usando l'immagine già pronta.
13+
914
## [1.0.4] - 2026-06-06
1015

1116
Release: **distribuzione ufficiale su PyPI e Docker Hub**. Ora `unit3dprep` si installa con `pip install unit3dprep` e l'immagine all-in-one con `docker pull hashdeveloper512/unit3dprep`. Inclusi i fix doc della guida Docker (Compose v2 richiesto).

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white)
99
![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-222222?style=for-the-badge&logo=github%20Pages&logoColor=white)
1010

11+
[![PyPI](https://img.shields.io/pypi/v/unit3dprep?style=for-the-badge&logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/unit3dprep/)
12+
[![Docker Hub](https://img.shields.io/docker/v/hashdeveloper512/unit3dprep?style=for-the-badge&logo=docker&logoColor=white&label=Docker%20Hub&sort=semver)](https://hub.docker.com/r/hashdeveloper512/unit3dprep)
13+
1114
Web UI + CLI di pre-flight per tracker Unit3D, accoppiata via HTTP a [`Unit3DWebUp`](https://pypi.org/project/Unit3DwebUp/) come backend di upload.
1215
Verifica tracce audio italiane, rinomina secondo la [nomenclatura ItaTorrents](docs/nomenclatura.md), crea hardlink in `~/seedings/` e orchestra il flusso `setenv → scan → maketorrent → upload → seed` su `Unit3DWebUp` con log live via WebSocket/SSE.
1316

@@ -63,6 +66,8 @@ docker compose up -d
6366
# apri http://127.0.0.1:8765
6467
```
6568

69+
> 🐳 Immagine pubblicata su Docker Hub: [`hashdeveloper512/unit3dprep`](https://hub.docker.com/r/hashdeveloper512/unit3dprep). Per saltare la build locale, in `docker-compose.yml` usa `image: hashdeveloper512/unit3dprep:latest` al posto di `build: .` → `docker compose up -d` la scarica.
70+
6671
> Serve **Compose v2** (`docker compose`). La vecchia `docker-compose` v1 (1.29.2) crasha su `up` con Docker Engine 25+ (`KeyError: 'ContainerConfig'`). Se `docker compose version` non funziona, installa il plugin v2 (binario utente, senza repo): vedi [Deploy › Docker › §1](https://davidesidoti.github.io/unit3dprep/docker/#1-prerequisiti).
6772
6873
Guida completa: [Deploy › Docker](https://davidesidoti.github.io/unit3dprep/docker/).

‎docs/docker.en.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ docker compose up -d
113113
docker compose logs -f
114114
```
115115

116+
!!! tip "Skip the build: use the published image"
117+
The official image is on Docker Hub: [`hashdeveloper512/unit3dprep`](https://hub.docker.com/r/hashdeveloper512/unit3dprep) (tags `latest`/`X.Y.Z`). To avoid building locally, in `docker-compose.yml` replace `build: .` with `image: hashdeveloper512/unit3dprep:latest` and skip `docker compose build` → `docker compose up -d` pulls the ready-made image.
118+
116119
In the logs you should see, in order (prefixed `[entrypoint]`): `starting redis on 127.0.0.1:6379`,
117120
`seeding /data/.env`, `webup is up`, and finally `starting unit3dprep-web on 0.0.0.0:8765` followed
118121
by uvicorn's `Application startup complete`.

‎docs/docker.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ docker compose up -d
113113
docker compose logs -f
114114
```
115115

116+
!!! tip "Salta la build: usa l'immagine pubblicata"
117+
L'immagine ufficiale è su Docker Hub: [`hashdeveloper512/unit3dprep`](https://hub.docker.com/r/hashdeveloper512/unit3dprep) (tag `latest`/`X.Y.Z`). Per non buildare in locale, nel `docker-compose.yml` sostituisci `build: .` con `image: hashdeveloper512/unit3dprep:latest` e salta `docker compose build` → `docker compose up -d` scarica l'immagine pronta.
118+
116119
Nei log dovresti vedere, in ordine (prefisso `[entrypoint]`): `starting redis on 127.0.0.1:6379`,
117120
`seeding /data/.env`, `webup is up`, e infine `starting unit3dprep-web on 0.0.0.0:8765` seguito
118121
dalla riga di uvicorn `Application startup complete`.

‎docs/installazione.en.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ source .venv/bin/activate
2424
pip install -e .
2525
```
2626

27+
!!! tip "Also on PyPI"
28+
The package is published: `pip install unit3dprep` (handy to integrate it into an existing environment). For the full flow in this guide a `git clone` is still preferable: `generate_hash.py` (step 3) and the systemd templates live in the repo. Otherwise use the [all-in-one Docker setup](docker.md), which needs none of this.
29+
2730
Entry points registered:
2831

2932
- `unit3dprep` → interactive CLI

‎docs/installazione.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ source .venv/bin/activate
2424
pip install -e .
2525
```
2626

27+
!!! tip "Disponibile anche su PyPI"
28+
Il pacchetto è pubblicato: `pip install unit3dprep` (utile per integrarlo in un ambiente esistente). Per il flusso completo di questa guida conviene comunque il `git clone`: `generate_hash.py` (passo 3) e i template systemd stanno nel repo. In alternativa puoi usare il [setup Docker all-in-one](docker.md), che non richiede nulla di tutto questo.
29+
2730
Entry points registrati:
2831

2932
- `unit3dprep` → CLI interattiva

0 commit comments

Comments
 (0)