From cfd0308d0ec26435348fb8e127e3f356d25e5035 Mon Sep 17 00:00:00 2001 From: blissful Date: Fri, 26 Apr 2024 12:59:46 -0400 Subject: [PATCH] clean up some todos in the docs --- README.md | 14 ++------------ docs/CONFIGURATION.md | 31 +++++++++++++++++++++++++++++-- docs/METADATA_TOOLS.md | 13 ++----------- rose/cli.py | 2 +- 4 files changed, 34 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 4e87d28..0fa5ed4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ # Rosé -> [!IMPORTANT] -> Rosé is under active development. Not all listed features exist yet. See [Milestone -> v0.4.0](https://github.com/azuline/rose/milestone/1) for progress updates. - Rosé is a music manager for Unix-based systems. Rosé provides a virtual FUSE filesystem for managing your music library and various functions for editing and improving your music library's metadata and tags. @@ -122,11 +118,8 @@ Artist, Genre, and Label. Rosé also provides a few other concepts for organizin Rosé's virtual filesystem organizes your music library by the metadata in the music tags. The quality of the virtual filesystem depends on the quality of the tags. -Thus, Rosé also provides the following functions to improve the tags of your music library: - -1. A text-based interface for manually modifying metadata, -2. A rules engine for bulk updating metadata, -3. And metadata importing from third-party sources. +Thus, Rosé also provides a text-based interface for manually modifying metadata and a rules engine +for bulk updating metadata to improve the tags of your music library. The rules engine allows you to pattern match tracks in your music library and apply tag changes to them. For example: @@ -151,8 +144,6 @@ CHUU - 2023. Howl/05. Hitchhiker.opus releaseartist[main]: ['CHUU'] -> ['Chuu'] ``` -_Demo Video TODO_ - # Features Rosé allows you to interact with and script against your music library through a virtual filesystem @@ -163,7 +154,6 @@ and through a CLI. A concise list of the features provided by the two interfaces - Configure directory and filename templates for releases and tracks - Edit release metadata as a text file - Run and store rules for (bulk) updating metadata -- Import metadata and cover art from third-party sources - Extract embedded cover art to an external file - Flag and unflag release "new"-ness - Group artist aliases together under a primary artist diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index 04471c9..339ed70 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -172,8 +172,35 @@ background. However, these daemons do not recover from failure or start on boot. If you would like them to, you can manage Rosé's processes with a service manager such as systemd. -Some sample systemd service files for managing Rosé are: +A sample systemd service file for managing Rosé is: ```ini -TODO +[Install] +WantedBy=graphical-session.target + +[Service] +ExecStart=/path/to/rose fs mount --foreground +Restart=always + +[Unit] +After=graphical-session-pre.target +PartOf=graphical-session.target +``` + +Or, as a Nix Home-Manager configuration: + +```nix +systemd.user.services.rose = { + Install = { + WantedBy = [ "graphical-session.target" ]; + }; + Service = { + ExecStart = "${pkgs.rose}/bin/rose fs mount --foreground"; + Restart = "always"; + }; + Unit = { + After = "graphical-session-pre.target"; + PartOf = "graphical-session.target"; + }; +}; ``` diff --git a/docs/METADATA_TOOLS.md b/docs/METADATA_TOOLS.md index f7498bc..e280140 100644 --- a/docs/METADATA_TOOLS.md +++ b/docs/METADATA_TOOLS.md @@ -4,11 +4,8 @@ Rosé relies on the metadata embedded in your music files to organize your music virtual filesystem. This means that the quality of the music tags is important for getting the most out of Rosé. -Therefore, Rosé provides the following tools to improve the metadata of your music: - -- A text-based interface for manually modifying release metadata, -- Metadata importing from third-party sources, -- And a rules engine to bulk update metadata. +Therefore, Rosé also provides a text-based interface for manually modifying metadata and a rules +engine for bulk updating metadata to improve the tags of your music library. > [!NOTE] > Rosé has opinionated conventions for how metadata is stored in audio tags. See @@ -492,9 +489,3 @@ LOOΠΔ - 2017. Chuu/02. Girl's Talk.opus This is a dry run, aborting. 7 tracks would have been modified. ``` - -# Metadata Import & Cover Art Downloading - -_In Development_ - -Sources: Discogs, MusicBrainz, Tidal, Deezer, Apple, Junodownload, Beatport, fanart.tv, and RYM. diff --git a/rose/cli.py b/rose/cli.py index 6b7b9e1..26a0806 100644 --- a/rose/cli.py +++ b/rose/cli.py @@ -165,7 +165,7 @@ def unmount(ctx: Context) -> None: @cli.group() def releases() -> None: """Manage releases.""" - # TODO: extract-covers / add-metadata-url / search-metadata-urls / import + # TODO: extract-covers @releases.command(name="print")