Update README.md

This commit is contained in:
tdeerenberg
2023-01-24 16:14:17 +01:00
committed by GitHub
parent e7ad42e5ca
commit 87986acf8c

View File

@ -7,6 +7,7 @@ A Python3 program that renames all selected music/audio files in a folder with a
## Features ## Features
- Rename many audio files at once - 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) - 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) - 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 - 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 ## Demo
## Dependencies
- [Python3](https://www.python.org/)
- [TinyTag](https://pypi.org/project/tinytag/) (Installable from Python Package Index)
## Installation and Usage ## Installation and Usage
Clone the repository and run the Python program Clone the repository and run the Python program
@ -23,11 +26,12 @@ Clone the repository and run the Python program
``` Bash ``` Bash
git clone https://github.com/tdeerenberg/Musort.git git clone https://github.com/tdeerenberg/Musort.git
cd Musort cd Musort
pip install requirements.txt
python3 musort.py 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: 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 ``` Bash
musort -d music_directory -f track.title.year -s _ musort music_directory track.title.year -s _ -r
``` ```
## Manual (options and arguments) ## Manual (options and arguments)
@ -35,36 +39,46 @@ musort -d music_directory -f track.title.year -s _
Musort © 2023 tdeerenberg (github.com/tdeerenberg) Musort © 2023 tdeerenberg (github.com/tdeerenberg)
DESCRIPTION: 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: 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 -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) -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: FORMAT OPTIONS:
album album as string album album as string
albumartist album artist as string albumartist album artist as string
artist artist name as string artist artist name as string
audio_offset number of bytes before audio data begins audio_offset number of bytes before audio data begins
bitdepth bit depth for lossless audio bitdepth bit depth for lossless audio
bitrate bitrate in kBits/s bitrate bitrate in kBits/s
comment file comment as string comment file comment as string
composer composer as string composer composer as string
disc disc number disc disc number
disc_total the total number of discs disc_total the total number of discs
duration duration of the song in seconds duration duration of the song in seconds
filesize file size in bytes filesize file size in bytes
genre genre as string genre genre as string
samplerate samples per second samplerate samples per second
title title of the song title title of the song
track track number as string track track number as string
track_total total number of tracks as string track_total total number of tracks as string
year year or date as string year year or date as string
``` ```
## Authors ## Authors