From 87986acf8c722951f025f8a78c8710ff4399fe60 Mon Sep 17 00:00:00 2001 From: tdeerenberg <113618658+tdeerenberg@users.noreply.github.com> Date: Tue, 24 Jan 2023 16:14:17 +0100 Subject: [PATCH] Update README.md --- README.md | 64 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 39 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index a2c1568..edf2da2 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ A Python3 program that renames all selected music/audio files in a folder with a ## Features - Rename many audio files at once +- Rename all files in subdirectories as well (recursive) - Choose the naming convention (ex. track.title.flac or artist.track.year.mp3) - Give a separator for the naming of the file (ex. track.title.flac or track_title.flac) - Works on all systems that can run Python @@ -15,7 +16,9 @@ A Python3 program that renames all selected music/audio files in a folder with a ## Demo - +## Dependencies +- [Python3](https://www.python.org/) +- [TinyTag](https://pypi.org/project/tinytag/) (Installable from Python Package Index) ## Installation and Usage Clone the repository and run the Python program @@ -23,11 +26,12 @@ Clone the repository and run the Python program ``` Bash git clone https://github.com/tdeerenberg/Musort.git cd Musort +pip install requirements.txt python3 musort.py ``` Alternatively, you could move `musort.py` into a directory in your `$PATH` and rename `musort.py` to `musort`. After that, the program can run like this: ``` Bash -musort -d music_directory -f track.title.year -s _ +musort music_directory track.title.year -s _ -r ``` ## Manual (options and arguments) @@ -35,36 +39,46 @@ musort -d music_directory -f track.title.year -s _ Musort © 2023 tdeerenberg (github.com/tdeerenberg) DESCRIPTION: -A Python3 program that renames all selected music/audio files in a folder with a specified naming convention +A Python3 program that renames all selected music/audio files in a folder with a specified naming convention USAGE: -musort [OPTION] [ARGUMENT]... +musort [DIRECTORY] [NAMING_CONVENTION] [OPTIONAL_OPTIONS]... -OPTIONS: + USAGE EXAMPLES: + musort ~/music track.title.year -s _ -r + musort /local/music disc.artist.title.album -r + musort ~/my_music track.title + +OPTIONAL OPTIONS: -h, --help Show the help menu --d, --dir Set the directory with the music files in it --f, --format Set the naming convention (ex. track.artist.year) Full list of option below. -s, --separator Set the separator for the filename (ex. '-s .' -> 01.track.flac and '-s -' -> 01-track.mp3) + Default separator ( . ) will be used if none is given +-r, --recursive Rename files in subdirectories as well + +NAMING CONVENTION: +FORMAT_OPTION.FORMAT_OPTION... The amount of format options does not matter. + It can be one, two, three, even all of them. + (See FORMAT OPTIONS below for all options) FORMAT OPTIONS: -album album as string -albumartist album artist as string -artist artist name as string -audio_offset number of bytes before audio data begins -bitdepth bit depth for lossless audio -bitrate bitrate in kBits/s -comment file comment as string -composer composer as string -disc disc number -disc_total the total number of discs -duration duration of the song in seconds -filesize file size in bytes -genre genre as string -samplerate samples per second -title title of the song -track track number as string -track_total total number of tracks as string -year year or date as string +album album as string +albumartist album artist as string +artist artist name as string +audio_offset number of bytes before audio data begins +bitdepth bit depth for lossless audio +bitrate bitrate in kBits/s +comment file comment as string +composer composer as string +disc disc number +disc_total the total number of discs +duration duration of the song in seconds +filesize file size in bytes +genre genre as string +samplerate samples per second +title title of the song +track track number as string +track_total total number of tracks as string +year year or date as string ``` ## Authors