gukebox 1.0.0.dev7__tar.gz → 1.0.0.dev9__tar.gz

{gukebox-1.0.0.dev7 → gukebox-1.0.0.dev9}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.3
 Name: gukebox
-Version: 1.0.0.dev7
+Version: 1.0.0.dev9
 Summary: A Jukebox to play music on speakers using 'CD' with NFC tag
-Keywords: jukebox,discstore,music,nfc
+Keywords: jukebox,music,nfc
 Author: Gudsfile
 License: MIT License
          
@@ -58,8 +58,9 @@ Description-Content-Type: text/markdown
 
 # Jukebox \[gukebox\]
 
-[![python versions](https://img.shields.io/pypi/pyversions/gukebox.svg)](https://pypi.python.org/pypi/gukebox)
-[![gukebox last version](https://img.shields.io/pypi/v/gukebox.svg)](https://pypi.python.org/pypi/gukebox)
+![rpi](https://img.shields.io/badge/-Zero%202W%20%7C%203%20%7C%205-C51A4A?logo=raspberry-pi&label=RPi&logoColor=C51A4A&labcolor=C51A4A)
+[![python versions](https://img.shields.io/pypi/pyversions/gukebox.svg?logo=python)](https://pypi.python.org/pypi/gukebox)
+[![gukebox last version](https://img.shields.io/pypi/v/gukebox.svg?logo=pypi)](https://pypi.python.org/pypi/gukebox)
 [![license](https://img.shields.io/pypi/l/gukebox.svg)](https://pypi.python.org/pypi/gukebox)
 [![actions status](https://github.com/gudsfile/jukebox/actions/workflows/python.yml/badge.svg)](https://github.com/gudsfile/jukebox/actions)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
@@ -70,7 +71,7 @@ Description-Content-Type: text/markdown
 
 🚧 At the moment:
 
-- NFC tags - CDs must be pre-populated in a JSON file (`discstore` included with `jukebox` may be of help to you)
+- NFC tags - CDs must be pre-populated in a JSON file (`jukebox-admin` included with `jukebox` may be of help to you)
 - supports many music providers (Spotify, Apple Music, etc.), just add the URIs to the JSON file
 - only works with Sonos speakers (there is a "dryrun" player for development), but code is designed to **add new ones**
 - **as soon as** the NFC tag is removed, the music pauses, then resumes when the NFC tag is replaced
@@ -84,10 +85,9 @@ Description-Content-Type: text/markdown
 
 - [Install](#install)
 - [First steps](#first-steps)
-  - [Discstore](#manage-the-library-with-the-discstore)
 - [Usage](#usage)
-  - [Readers](#readers)
-  - [Players](#players)
+- [Readers](#readers)
+- [Players](#players)
 - [The library file](#the-library-file)
 - [Developer setup](#developer-setup)
 
@@ -161,18 +161,18 @@ uv sync
 
 ## First steps
 
-Initialize the library file with `discstore` or manually create it at `~/.config/jukebox/library.json`.
+Initialize the library file with `jukebox-admin` or manually create it at `~/.config/jukebox/library.json`.
 
-### Manage the library with the discstore
+### Manage the library with the Admin CLI
 
 To associate an URI with an NFC tag:
 
 ```shell
-discstore add tag_id --uri /path/to/media.mp3
+jukebox-admin library add tag_id --uri /path/to/media.mp3
 ```
 or to pull the `tag_id` currently on the reader:
 ```shell
-discstore add --from-current --uri /path/to/media.mp3
+jukebox-admin library add --from-current --uri /path/to/media.mp3
 ```
 
 Other commands are available, use `--help` to see them.
@@ -204,8 +204,6 @@ uv run --extra api jukebox-admin api
 uv run --extra ui jukebox-admin ui
 ```
 
-`discstore settings ...`, `discstore api`, and `discstore ui` remain available as compatibility commands, but `jukebox-admin` is the preferred CLI for admin flows.
-
 ### Manage the library manually
 
 Complete your `~/.config/jukebox/library.json` file with each tag id and the expected media URI.
@@ -216,16 +214,18 @@ Take a look at `library.example.json` and the [The library file](#the-library-fi
 Start the jukebox with the `jukebox` command (show help message with `--help`)
 
 ```shell
-jukebox PLAYER_TO_USE READER_TO_USE
+jukebox --player PLAYER --reader READER
 ```
 
 🎉 With choosing the `sonos` player and `pn532` reader, by approaching a NFC tag stored in the `library.json` file, you should hear the associated music begins.
 
-Optional Parameters
+**Optional Parameters**
 
 | Parameter | Description |
 | --- | --- |
 | `--help` | Show help message. |
+| `--player PLAYER` | Player to use (`sonos`, `dryrun`). |
+| `--reader READER` | Reader to use (`pn532`, `dryrun`). |
 | `--library` | Path to the library file, default: `~/.config/jukebox/library.json`. |
 | `--pause-delay SECONDS` | Grace period before pausing when the NFC tag is removed. Fractional values such as `0.5` or `0.2` are supported, with a minimum of `0.2` seconds to avoid pausing on brief missed reads. Default: 0.25 seconds. |
 | `--pause-duration SECONDS` | Maximum duration of a pause before resetting the queue. Default: 900 seconds (15 minutes). |
@@ -234,40 +234,29 @@ Optional Parameters
 
 ### Readers
 
-**Dry run** (`dryrun`)
-Read a text entry.
-Allows you to simulate reading an NFC tag by writting the tag id in the console.
-Expected syntax: `tag_id` or `tag_id duration_seconds`.
-- tag_id: the full identifier of the tag, in the format required by the system
-- duration_seconds: a non-negative number of seconds used to simulate how long the tag remains in place. Fractional values are allowed.
-Complete example: `your:tag:uid 2.5`
+| Name | Description |
+| --- | --- |
+| Dry Run (`dryrun`) | Simulates NFC tag reading via stdin. Input format: `tag_id` or `tag_id duration_seconds`. |
+| Pn532 NFC (`pn532`) | Reads physical NFC tags. Works with a **PN532** reader and **NTAG2xx** tags. Requires the `pn532` extra and SPI enabled on the Raspberry Pi. |
 
-**NFC Pn532** (`pn532`)
-Read an NFC tag and get its UID.
-This project works with an NFC reader like the **PN532** and NFC tags like the **NTAG2xx**.
-It is configured according to the [Waveshare PN532 wiki](https://www.waveshare.com/wiki/PN532_NFC_HAT).
-Don't forget to enable the SPI interface using the command `sudo raspi-config`, then go to: `Interface Options > SPI > Enable > Yes`.
+> [!NOTE]
+> See [docs/readers.md](docs/readers.md) for full setup, hardware requirements, and settings reference.
 
 ### Players
 
-**Dry run** (`dryrun`)
-Displays the events that a real speaker would have performed (`playing …`, `pause`, etc.).
-
-**Sonos** (`sonos`) [![SoCo](https://img.shields.io/badge/based%20on-SoCo-000)](https://github.com/SoCo/SoCo)
-Play music through a Sonos speaker.
-Three ways to select the speaker (mutually exclusive):
+| Name | Description |
+| --- | --- |
+| Dry Run (`dryrun`) | Displays the events that a real speaker would have performed (`playing …`, `pause`, etc.). |
+| Sonos (`sonos`) | [![SoCo](https://img.shields.io/badge/based%20on-SoCo-000)](https://github.com/SoCo/SoCo) Plays music through a Sonos speaker. Select by IP (`--sonos-host`), by name (`--sonos-name`), or let it auto-discover. |
 
-| Option | CLI flag | Environment variable | Behaviour |
-| --- | --- | --- | --- |
-| By IP | `--sonos-host 192.168.0.x` | `JUKEBOX_SONOS_HOST` | Connect directly, no discovery |
-| By name | `--sonos-name "Living Room"` | `JUKEBOX_SONOS_NAME` | Discover, then filter by name (case-sensitive) |
-| Auto | *(omit both)* | *(omit both)* | Discover, pick the first speaker alphabetically |
+> [!NOTE]
+> See [docs/players.md](docs/players.md) for the full configuration reference.
 
 ## The library file
 
 The `library.json` file is a JSON file that contains the artists, albums and tags.
 It is used by the `jukebox` command to find the corresponding metadata for each tag.
-And the `discstore` command help you to managed this file with a CLI, an interactive CLI, an API or an UI (see `discstore --help`).
+And the `jukebox-admin library` command help you to managed this file with a CLI, an interactive CLI, an API or an UI (see `jukebox-admin --help`).
 
 By default, this file should be placed at `~/.config/jukebox/library.json`. But you can use another path by creating a `JUKEBOX_LIBRARY_PATH` environment variable or with the `--library` argument.
 
@@ -341,9 +330,7 @@ uv sync
 
 Add `--all-extras` to install dependencies for all extras (`api` and `ui`).
 
-If needed, set `JUKEBOX_SONOS_HOST` (IP) or `JUKEBOX_SONOS_NAME` (speaker name) to select your Sonos speaker (see [Players](#players)).
-If neither is set, the jukebox will auto-discover a speaker on the network.
-To do this you can use a `.env` file and `uv run --env-file .env <command to run>`.
+If needed, you can use a `.env` file and `uv run --env-file .env <command to run>`.
 A `.env.example` file is available, you can copy it and modify it to use it.
 
 Create a `library.json` file and complete it with the desired NFC tags and CDs.
@@ -354,12 +341,7 @@ Take a look at `library.example.json` and the [The library file](#the-library-fi
 Start the jukebox with `uv` and use `--help` to show help message
 
 ```shell
-uv run jukebox PLAYER_TO_USE READER_TO_USE
-```
-
-Start the discstore `uv` and use `--help` to show help message
-```shell
-uv run discstore --help
+uv run jukebox --player PLAYER_TO_USE --reader READER_TO_USE
 ```
 
 Use `jukebox-admin` for admin commands:
@@ -375,15 +357,7 @@ uv run --extra api jukebox-admin api
 uv run --extra ui jukebox-admin ui
 ```
 
-Legacy compatibility commands remain available during the transition:
-
-```shell
-uv run discstore settings show
-uv run --extra api discstore api
-uv run --extra ui discstore ui
-```
-
-Other commands are available:
+### Development commands
 
 | Command | Description |
 | --- | --- |

{gukebox-1.0.0.dev7 → gukebox-1.0.0.dev9}/README.md

@@ -1,7 +1,8 @@
 # Jukebox \[gukebox\]
 
-[![python versions](https://img.shields.io/pypi/pyversions/gukebox.svg)](https://pypi.python.org/pypi/gukebox)
-[![gukebox last version](https://img.shields.io/pypi/v/gukebox.svg)](https://pypi.python.org/pypi/gukebox)
+![rpi](https://img.shields.io/badge/-Zero%202W%20%7C%203%20%7C%205-C51A4A?logo=raspberry-pi&label=RPi&logoColor=C51A4A&labcolor=C51A4A)
+[![python versions](https://img.shields.io/pypi/pyversions/gukebox.svg?logo=python)](https://pypi.python.org/pypi/gukebox)
+[![gukebox last version](https://img.shields.io/pypi/v/gukebox.svg?logo=pypi)](https://pypi.python.org/pypi/gukebox)
 [![license](https://img.shields.io/pypi/l/gukebox.svg)](https://pypi.python.org/pypi/gukebox)
 [![actions status](https://github.com/gudsfile/jukebox/actions/workflows/python.yml/badge.svg)](https://github.com/gudsfile/jukebox/actions)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
@@ -12,7 +13,7 @@
 
 🚧 At the moment:
 
-- NFC tags - CDs must be pre-populated in a JSON file (`discstore` included with `jukebox` may be of help to you)
+- NFC tags - CDs must be pre-populated in a JSON file (`jukebox-admin` included with `jukebox` may be of help to you)
 - supports many music providers (Spotify, Apple Music, etc.), just add the URIs to the JSON file
 - only works with Sonos speakers (there is a "dryrun" player for development), but code is designed to **add new ones**
 - **as soon as** the NFC tag is removed, the music pauses, then resumes when the NFC tag is replaced
@@ -26,10 +27,9 @@
 
 - [Install](#install)
 - [First steps](#first-steps)
-  - [Discstore](#manage-the-library-with-the-discstore)
 - [Usage](#usage)
-  - [Readers](#readers)
-  - [Players](#players)
+- [Readers](#readers)
+- [Players](#players)
 - [The library file](#the-library-file)
 - [Developer setup](#developer-setup)
 
@@ -103,18 +103,18 @@ uv sync
 
 ## First steps
 
-Initialize the library file with `discstore` or manually create it at `~/.config/jukebox/library.json`.
+Initialize the library file with `jukebox-admin` or manually create it at `~/.config/jukebox/library.json`.
 
-### Manage the library with the discstore
+### Manage the library with the Admin CLI
 
 To associate an URI with an NFC tag:
 
 ```shell
-discstore add tag_id --uri /path/to/media.mp3
+jukebox-admin library add tag_id --uri /path/to/media.mp3
 ```
 or to pull the `tag_id` currently on the reader:
 ```shell
-discstore add --from-current --uri /path/to/media.mp3
+jukebox-admin library add --from-current --uri /path/to/media.mp3
 ```
 
 Other commands are available, use `--help` to see them.
@@ -146,8 +146,6 @@ uv run --extra api jukebox-admin api
 uv run --extra ui jukebox-admin ui
 ```
 
-`discstore settings ...`, `discstore api`, and `discstore ui` remain available as compatibility commands, but `jukebox-admin` is the preferred CLI for admin flows.
-
 ### Manage the library manually
 
 Complete your `~/.config/jukebox/library.json` file with each tag id and the expected media URI.
@@ -158,16 +156,18 @@ Take a look at `library.example.json` and the [The library file](#the-library-fi
 Start the jukebox with the `jukebox` command (show help message with `--help`)
 
 ```shell
-jukebox PLAYER_TO_USE READER_TO_USE
+jukebox --player PLAYER --reader READER
 ```
 
 🎉 With choosing the `sonos` player and `pn532` reader, by approaching a NFC tag stored in the `library.json` file, you should hear the associated music begins.
 
-Optional Parameters
+**Optional Parameters**
 
 | Parameter | Description |
 | --- | --- |
 | `--help` | Show help message. |
+| `--player PLAYER` | Player to use (`sonos`, `dryrun`). |
+| `--reader READER` | Reader to use (`pn532`, `dryrun`). |
 | `--library` | Path to the library file, default: `~/.config/jukebox/library.json`. |
 | `--pause-delay SECONDS` | Grace period before pausing when the NFC tag is removed. Fractional values such as `0.5` or `0.2` are supported, with a minimum of `0.2` seconds to avoid pausing on brief missed reads. Default: 0.25 seconds. |
 | `--pause-duration SECONDS` | Maximum duration of a pause before resetting the queue. Default: 900 seconds (15 minutes). |
@@ -176,40 +176,29 @@ Optional Parameters
 
 ### Readers
 
-**Dry run** (`dryrun`)
-Read a text entry.
-Allows you to simulate reading an NFC tag by writting the tag id in the console.
-Expected syntax: `tag_id` or `tag_id duration_seconds`.
-- tag_id: the full identifier of the tag, in the format required by the system
-- duration_seconds: a non-negative number of seconds used to simulate how long the tag remains in place. Fractional values are allowed.
-Complete example: `your:tag:uid 2.5`
+| Name | Description |
+| --- | --- |
+| Dry Run (`dryrun`) | Simulates NFC tag reading via stdin. Input format: `tag_id` or `tag_id duration_seconds`. |
+| Pn532 NFC (`pn532`) | Reads physical NFC tags. Works with a **PN532** reader and **NTAG2xx** tags. Requires the `pn532` extra and SPI enabled on the Raspberry Pi. |
 
-**NFC Pn532** (`pn532`)
-Read an NFC tag and get its UID.
-This project works with an NFC reader like the **PN532** and NFC tags like the **NTAG2xx**.
-It is configured according to the [Waveshare PN532 wiki](https://www.waveshare.com/wiki/PN532_NFC_HAT).
-Don't forget to enable the SPI interface using the command `sudo raspi-config`, then go to: `Interface Options > SPI > Enable > Yes`.
+> [!NOTE]
+> See [docs/readers.md](docs/readers.md) for full setup, hardware requirements, and settings reference.
 
 ### Players
 
-**Dry run** (`dryrun`)
-Displays the events that a real speaker would have performed (`playing …`, `pause`, etc.).
-
-**Sonos** (`sonos`) [![SoCo](https://img.shields.io/badge/based%20on-SoCo-000)](https://github.com/SoCo/SoCo)
-Play music through a Sonos speaker.
-Three ways to select the speaker (mutually exclusive):
+| Name | Description |
+| --- | --- |
+| Dry Run (`dryrun`) | Displays the events that a real speaker would have performed (`playing …`, `pause`, etc.). |
+| Sonos (`sonos`) | [![SoCo](https://img.shields.io/badge/based%20on-SoCo-000)](https://github.com/SoCo/SoCo) Plays music through a Sonos speaker. Select by IP (`--sonos-host`), by name (`--sonos-name`), or let it auto-discover. |
 
-| Option | CLI flag | Environment variable | Behaviour |
-| --- | --- | --- | --- |
-| By IP | `--sonos-host 192.168.0.x` | `JUKEBOX_SONOS_HOST` | Connect directly, no discovery |
-| By name | `--sonos-name "Living Room"` | `JUKEBOX_SONOS_NAME` | Discover, then filter by name (case-sensitive) |
-| Auto | *(omit both)* | *(omit both)* | Discover, pick the first speaker alphabetically |
+> [!NOTE]
+> See [docs/players.md](docs/players.md) for the full configuration reference.
 
 ## The library file
 
 The `library.json` file is a JSON file that contains the artists, albums and tags.
 It is used by the `jukebox` command to find the corresponding metadata for each tag.
-And the `discstore` command help you to managed this file with a CLI, an interactive CLI, an API or an UI (see `discstore --help`).
+And the `jukebox-admin library` command help you to managed this file with a CLI, an interactive CLI, an API or an UI (see `jukebox-admin --help`).
 
 By default, this file should be placed at `~/.config/jukebox/library.json`. But you can use another path by creating a `JUKEBOX_LIBRARY_PATH` environment variable or with the `--library` argument.
 
@@ -283,9 +272,7 @@ uv sync
 
 Add `--all-extras` to install dependencies for all extras (`api` and `ui`).
 
-If needed, set `JUKEBOX_SONOS_HOST` (IP) or `JUKEBOX_SONOS_NAME` (speaker name) to select your Sonos speaker (see [Players](#players)).
-If neither is set, the jukebox will auto-discover a speaker on the network.
-To do this you can use a `.env` file and `uv run --env-file .env <command to run>`.
+If needed, you can use a `.env` file and `uv run --env-file .env <command to run>`.
 A `.env.example` file is available, you can copy it and modify it to use it.
 
 Create a `library.json` file and complete it with the desired NFC tags and CDs.
@@ -296,12 +283,7 @@ Take a look at `library.example.json` and the [The library file](#the-library-fi
 Start the jukebox with `uv` and use `--help` to show help message
 
 ```shell
-uv run jukebox PLAYER_TO_USE READER_TO_USE
-```
-
-Start the discstore `uv` and use `--help` to show help message
-```shell
-uv run discstore --help
+uv run jukebox --player PLAYER_TO_USE --reader READER_TO_USE
 ```
 
 Use `jukebox-admin` for admin commands:
@@ -317,15 +299,7 @@ uv run --extra api jukebox-admin api
 uv run --extra ui jukebox-admin ui
 ```
 
-Legacy compatibility commands remain available during the transition:
-
-```shell
-uv run discstore settings show
-uv run --extra api discstore api
-uv run --extra ui discstore ui
-```
-
-Other commands are available:
+### Development commands
 
 | Command | Description |
 | --- | --- |

{gukebox-1.0.0.dev7 → gukebox-1.0.0.dev9}/discstore/adapters/inbound/api/current_tag_router.py

@@ -1,6 +1,7 @@
 from typing import Any, Optional
 
 from fastapi import APIRouter, HTTPException, Response, status
+from pydantic import ValidationError
 
 from discstore.adapters.inbound.api.models import (
     CurrentTagDiscOutput,
@@ -92,8 +93,8 @@ def build_current_tag_router(
 
         try:
             new_disc = Disc(**disc.model_dump())
-            add_disc.execute(current_tag_status.tag_id, new_disc)
-            return build_current_tag_disc_output(current_tag_status.tag_id, new_disc)
+            created_disc = add_disc.execute(current_tag_status.tag_id, new_disc)
+            return build_current_tag_disc_output(current_tag_status.tag_id, created_disc)
         except ValueError as value_err:
             raise HTTPException(status_code=409, detail=str(value_err))
         except Exception as err:
@@ -121,14 +122,16 @@ def build_current_tag_router(
         try:
             metadata = None
             if disc_patch.metadata is not None:
-                metadata = DiscMetadata(**disc_patch.metadata.model_dump(exclude_unset=True, exclude_none=True))
+                metadata = DiscMetadata(**disc_patch.metadata.model_dump(exclude_unset=True))
 
             option = None
             if disc_patch.option is not None:
-                option = DiscOption(**disc_patch.option.model_dump(exclude_unset=True, exclude_none=True))
+                option = DiscOption(**disc_patch.option.model_dump(exclude_unset=True))
 
-            edit_disc.execute(current_tag_status.tag_id, disc_patch.uri, metadata, option)
-            return build_current_tag_disc_output(current_tag_status.tag_id, get_disc.execute(current_tag_status.tag_id))
+            updated_disc = edit_disc.execute(current_tag_status.tag_id, disc_patch.uri, metadata, option)
+            return build_current_tag_disc_output(current_tag_status.tag_id, updated_disc)
+        except ValidationError as err:
+            raise HTTPException(status_code=422, detail=err.errors())
         except ValueError as value_err:
             raise HTTPException(status_code=404, detail=str(value_err))
         except Exception as err:

{gukebox-1.0.0.dev7 → gukebox-1.0.0.dev9}/discstore/adapters/inbound/api/discs_router.py

@@ -1,6 +1,7 @@
 from typing import Dict
 
 from fastapi import APIRouter, HTTPException, Response, status
+from pydantic import ValidationError
 
 from discstore.adapters.inbound.api.models import DiscInput, DiscOutput, DiscPatchInput
 from discstore.domain.entities import Disc, DiscMetadata, DiscOption
@@ -48,13 +49,15 @@ def build_discs_router(
         try:
             metadata = None
             if disc_patch.metadata is not None:
-                metadata = DiscMetadata(**disc_patch.metadata.model_dump(exclude_unset=True, exclude_none=True))
+                metadata = DiscMetadata(**disc_patch.metadata.model_dump(exclude_unset=True))
 
             option = None
             if disc_patch.option is not None:
-                option = DiscOption(**disc_patch.option.model_dump(exclude_unset=True, exclude_none=True))
+                option = DiscOption(**disc_patch.option.model_dump(exclude_unset=True))
 
             return edit_disc.execute(tag_id, disc_patch.uri, metadata, option)
+        except ValidationError as err:
+            raise HTTPException(status_code=422, detail=err.errors())
         except ValueError as value_err:
             raise HTTPException(status_code=404, detail=str(value_err))
         except Exception as err:

{gukebox-1.0.0.dev7 → gukebox-1.0.0.dev9}/discstore/adapters/inbound/api_controller.py

@@ -23,7 +23,7 @@ except ModuleNotFoundError as e:
     if e.name != "fastapi":
         raise
     raise ModuleNotFoundError(
-        optional_extra_dependency_message("The `api_controller` module", "api", "discstore api")
+        optional_extra_dependency_message("The `api_controller` module", "api", "jukebox-admin api")
     ) from e
 from discstore.domain.use_cases.add_disc import AddDisc
 from discstore.domain.use_cases.edit_disc import EditDisc
@@ -108,8 +108,8 @@ class APIController:
         self.settings_service = settings_service
         self.sonos_service = sonos_service
         self.app = FastAPI(
-            title="DiscStore API",
-            description="API for managing Jukebox disc library",
+            title="Jukebox Admin API",
+            description="API for managing Jukebox disc library and settings",
             docs_url="/docs",
             redoc_url="/redoc",
         )