Remove audio extraction from public api

p3zo · Jun 19, 2024 · 929b28d · 929b28d
1 parent 7176ade
commit 929b28d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/chord_progressions/__init__.py b/chord_progressions/__init__.py
@@ -17,7 +17,6 @@
 
 from chord_progressions.chord import Chord
 from chord_progressions.extract import (
-    extract_progression_from_audio,
     extract_progression_from_midi,
 )
 from chord_progressions.pitch import (
@@ -40,7 +39,6 @@
 # Use __all__ to let type checkers know what is part of the public API
 __all__ = [
     Chord,
-    extract_progression_from_audio,
     extract_progression_from_midi,
     get_midi_num_from_note,
     get_note_from_midi_num,

diff --git a/docs/extract.md b/docs/extract.md
@@ -14,8 +14,10 @@ progression = extract_progression_from_midi('my_file.mid')
 
 ## Extract chords from an audio file
 
+NOTE: this requires installing [Essentia](http://essentia.upf.edu/documentation/installing.html) with Python bindings which is not included in this library.
+
 ```python
-from chord_progressions import extract_progression_from_audio
+from chord_progressions.extract import extract_progression_from_audio
 
 progression = extract_progression_from_audio('my_file.wav')
 ```