gukebox 1.0.0.dev1__tar.gz → 1.0.0.dev2__tar.gz

{gukebox-1.0.0.dev1 → gukebox-1.0.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gukebox
-Version: 1.0.0.dev1
+Version: 1.0.0.dev2
 Summary: A Jukebox to play music on speakers using 'CD' with NFC tag
 Keywords: jukebox,discstore,music,nfc
 Author: Gudsfile
@@ -160,7 +160,7 @@ uv sync
 
 ## First steps
 
-Initialize the library file with `discstore` or manually create it at `~/.jukebox/library.json`.
+Initialize the library file with `discstore` or manually create it at `~/.config/jukebox/library.json`.
 
 ### Manage the library with the discstore
 
@@ -207,7 +207,7 @@ uv run --extra ui jukebox-admin ui
 
 ### Manage the library manually
 
-Complete your `~/.jukebox/library.json` file with each tag id and the expected media URI.
+Complete your `~/.config/jukebox/library.json` file with each tag id and the expected media URI.
 Take a look at `library.example.json` and the [The library file](#the-library-file) section for more information.
 
 ## Usage
@@ -225,7 +225,7 @@ Optional Parameters
 | Parameter | Description |
 | --- | --- |
 | `--help` | Show help message. |
-| `--library` | Path to the library file, default: `~/.jukebox/library.json`. |
+| `--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). |
 | `--verbose` | Enable verbose logging. |
@@ -268,7 +268,7 @@ The `library.json` file is a JSON file that contains the artists, albums and tag
 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`).
 
-By default, this file should be placed at `~/.jukebox/library.json`. But you can use another path by creating a `JUKEBOX_LIBRARY_PATH` environment variable or with the `--library` argument.
+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.
 
 ```json
 {
@@ -307,7 +307,7 @@ It is also possible to use the `shuffle` key to play the album in shuffle mode:
     }
 ```
 
-To summarize, for example, if you have the following `~/.jukebox/library.json` file:
+To summarize, for example, if you have the following `~/.config/jukebox/library.json` file:
 
 ```json
 {

{gukebox-1.0.0.dev1 → gukebox-1.0.0.dev2}/README.md

@@ -103,7 +103,7 @@ uv sync
 
 ## First steps
 
-Initialize the library file with `discstore` or manually create it at `~/.jukebox/library.json`.
+Initialize the library file with `discstore` or manually create it at `~/.config/jukebox/library.json`.
 
 ### Manage the library with the discstore
 
@@ -150,7 +150,7 @@ uv run --extra ui jukebox-admin ui
 
 ### Manage the library manually
 
-Complete your `~/.jukebox/library.json` file with each tag id and the expected media URI.
+Complete your `~/.config/jukebox/library.json` file with each tag id and the expected media URI.
 Take a look at `library.example.json` and the [The library file](#the-library-file) section for more information.
 
 ## Usage
@@ -168,7 +168,7 @@ Optional Parameters
 | Parameter | Description |
 | --- | --- |
 | `--help` | Show help message. |
-| `--library` | Path to the library file, default: `~/.jukebox/library.json`. |
+| `--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). |
 | `--verbose` | Enable verbose logging. |
@@ -211,7 +211,7 @@ The `library.json` file is a JSON file that contains the artists, albums and tag
 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`).
 
-By default, this file should be placed at `~/.jukebox/library.json`. But you can use another path by creating a `JUKEBOX_LIBRARY_PATH` environment variable or with the `--library` argument.
+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.
 
 ```json
 {
@@ -250,7 +250,7 @@ It is also possible to use the `shuffle` key to play the album in shuffle mode:
     }
 ```
 
-To summarize, for example, if you have the following `~/.jukebox/library.json` file:
+To summarize, for example, if you have the following `~/.config/jukebox/library.json` file:
 
 ```json
 {

{gukebox-1.0.0.dev1 → gukebox-1.0.0.dev2}/jukebox/settings/entities.py

@@ -1,3 +1,4 @@
+import os
 from typing import Optional
 
 try:
@@ -12,6 +13,11 @@ from jukebox.shared.timing import MIN_PAUSE_DELAY_SECONDS
 from .runtime_validation import validate_resolved_jukebox_runtime_rules
 
 
+def _resolve_default_library_path():
+    xdg_config_home = os.environ.get("XDG_CONFIG_HOME", "~/.config")
+    return os.path.expanduser(os.path.join(xdg_config_home, "jukebox/library.json"))
+
+
 class StrictModel(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
@@ -94,7 +100,7 @@ class ServerSettings(StrictModel):
 
 
 class PathsSettings(StrictModel):
-    library_path: str = "~/.jukebox/library.json"
+    library_path: str = _resolve_default_library_path()
 
 
 class AdminSettings(StrictModel):

{gukebox-1.0.0.dev1 → gukebox-1.0.0.dev2}/jukebox/settings/file_settings_repository.py

@@ -2,6 +2,7 @@ import json
 import os
 import tempfile
 from contextlib import suppress
+from typing import Optional
 
 from pydantic import ValidationError
 
@@ -11,12 +12,14 @@ from .errors import InvalidSettingsError, MalformedSettingsFileError
 from .migration import CURRENT_SETTINGS_SCHEMA_VERSION, migrate_settings_data
 from .types import JsonObject
 
-DEFAULT_SETTINGS_PATH = os.path.expanduser("~/.jukebox/settings.json")
-
 
 class FileSettingsRepository:
-    def __init__(self, filepath: str = DEFAULT_SETTINGS_PATH):
-        self.filepath = os.path.expanduser(filepath)
+    def __init__(self, filepath: Optional[str] = None):
+        if filepath is None:
+            xdg_config_home = os.environ.get("XDG_CONFIG_HOME", "~/.config")
+            self.filepath = os.path.expanduser(os.path.join(xdg_config_home, "jukebox/settings.json"))
+        else:
+            self.filepath = os.path.expanduser(filepath)
 
     def load_persisted_settings_data(self) -> JsonObject:
         if not os.path.exists(self.filepath):

{gukebox-1.0.0.dev1 → gukebox-1.0.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gukebox"
-version = "1.0.0.dev1"
+version = "1.0.0.dev2"
 description = "A Jukebox to play music on speakers using 'CD' with NFC tag"
 authors = [{ name = "Gudsfile" }]
 readme = "README.md"