https://github.com/roboyoshi/hek
Check your music collection given a set of rules
https://github.com/roboyoshi/hek
Last synced: 11 months ago
JSON representation
Check your music collection given a set of rules
- Host: GitHub
- URL: https://github.com/roboyoshi/hek
- Owner: roboyoshi
- License: gpl-3.0
- Created: 2019-07-08T21:52:51.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-08T15:14:12.000Z (almost 7 years ago)
- Last Synced: 2025-06-05T06:27:13.648Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 56.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hek
Python script that checks your music collection given a set of rules
- Does not modify files
- Reads FLAC and mp3 tags
- Checks capitalization, filetypes, missing tags
- Manage exceptions
## Depends on
- `python-mutagen`
## Installation
```bash
$ git clone https://github.com/dunon/hek.git
$ cd hek
$ sudo cp hek.py /usr/bin/hek
```
### Arch Linux
Available on the [AUR](https://aur.archlinux.org/packages/hek/)
## Usage
```bash
$ hek ~/Music
$ hek . # run on current directory
$ hek -v # display version
$ hek ~/Music --files # check files only
$ hek ~/Music --tags # check tags only
```
## Configuration
See [example_config](https://github.com/dunon/hek/tree/master/example_config)
### Rules
Stored in `~/.config/hek/rules`
- Capitalize after these symbols `capitalize_after`
- Only allow these filetypes `filetypes`
- How directories must end `dir_ends`
- Do not allow certain symbols or sequences in files `sequences_files`
- Do not allow certain symbols or sequences in tags `sequences_tags`
### Exceptions
Stored in `~/.config/hek`
- Some words are not capitalized `ignore_case`
- Do not warn about lower case after ' `ignore_quote_case`
- Allow symbols or sequences as exceptions `ignore_contains`
- Do no warn about missing year `ignore_year`
- Do not warn about different albumartist/artist `ignore_albumartist`
- Ignore how directory ends `ignore_dir_ends`
## License
hek is released under the GNU GPLv3 license. See `LICENSE` for details.