Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ python -m venv .venv
source .venv/bin/activate # or "Scripts\activate" on Windows
pip install -r requirements.txt
```
Essentia is only needed if you plan to use the optional tempo engine
(`engine="essentia"` in the playlist tools). Prebuilt wheels are not
published for every platform, so Windows users in particular may need to
install a specific wheel manually:

```bash
pip install "essentia==2.1b6.dev1034"
```

If you skip Essentia, the default `librosa`-based engine continues to work.


The indexer will exit with an error if the real `mutagen` package is missing,
so ensure all dependencies are installed before running.
Expand Down
5 changes: 4 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ ffmpeg-python
pyacoustid
musicbrainzngs
python-vlc
essentia
librosa
scipy
numpy
Expand All @@ -15,6 +14,10 @@ matplotlib
Pillow
requests
typing_extensions
# optional audio analysis engines
# Essentia wheels are not available on all platforms (notably Windows).
# Install manually if you want to use the Essentia tempo engine:
# pip install "essentia==2.1b6.dev1034"
# optional metadata helpers
spotipy
tidal-dl
Expand Down