Rename command

README.md

@@ -9,14 +9,37 @@ A rudimentary audio tagger based on Discogs metadata.
 
 # Usage
 ```shell
+NAME
+    discogs-tag
+
+SYNOPSIS
+    discogs-tag COMMAND
+
+COMMANDS
+    COMMAND is one of the following:
+
+     tag
+       Tag the audio files with the given Discogs release.
+
+     copy
+       Copy the audio tags from source to destination folders.
+
+     rename
+       Rename the audio files based on the given format string.
+```
+## tag
+```shell
 NAME
     discogs-tag tag - Tag the audio files with the given Discogs release.
 
 SYNOPSIS
     discogs-tag tag RELEASE <flags>
 
 DESCRIPTION
-    The skip flag can take one or more of the following values, comma-separated:
+    The RELEASE is the numeric portion of a Discogs release URL, e.g. 16215626 in
+        https://www.discogs.com/release/16215626-Pink-Floyd-Wish-You-Were-Here
+
+    The SKIP flag can take one or more of the following values, comma-separated:
         artist, composer, title, position, date, subtrack, album, genre, albumartist
 
 POSITIONAL ARGUMENTS
@@ -36,6 +59,7 @@ FLAGS
 NOTES
     You can also use flags syntax for POSITIONAL ARGUMENTS
 ```
+## copy
 ```shell
 NAME
     discogs-tag copy - Copy the audio tags from source to destination folders.
@@ -44,7 +68,7 @@ SYNOPSIS
     discogs-tag copy SRC <flags>
 
 DESCRIPTION
-    The skip flag can take one or more of the following values, comma-separated:
+    The SKIP flag can take one or more of the following values, comma-separated:
         artist, composer, title, position, date, subtrack, album, genre, albumartist
 
 POSITIONAL ARGUMENTS
@@ -64,3 +88,39 @@ FLAGS
 NOTES
     You can also use flags syntax for POSITIONAL ARGUMENTS
 ```
+## rename
+```shell
+NAME
+    discogs-tag rename - Rename the audio files based on the given format string.
+
+SYNOPSIS
+    discogs-tag rename FORMAT <flags>
+
+DESCRIPTION
+    The FORMAT string specifies how to rename the audio files and/or directories according to the following tags:
+        %a Artist
+        %z Album artist
+        %b Album title
+        %p Composer
+        %d Disc nummber
+        %g Genre
+        %n Track number
+        %t Track title
+        %y Year
+        /  Directory separator: Specifies subdirectories to be created starting from the given directory.
+           Non-audio files will be moved to their existing subdirectories within the destination root which is assumed to be unique.
+
+POSITIONAL ARGUMENTS
+    FORMAT
+
+FLAGS
+    --dir=DIR
+        Default: './'
+    --dry=DRY
+        Default: False
+    -i, --ignore=IGNORE
+        Default: False
+
+NOTES
+    You can also use flags syntax for POSITIONAL ARGUMENTS
+```

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "discogs-tag"
-version = "0.3.2"
+version = "0.4.0"
 description = "A rudimentary audio tagger based on Discogs metadata."
 authors = ["infojunkie <[email protected]>"]
 readme = "README.md"
@@ -11,6 +11,7 @@ python = "^3.10"
 fire = "^0.5.0"
 mutagen = "^1.46.0"
 importlib-metadata = "^6.8.0"
+pathvalidate = "^3.2.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0.0"