Re-add convenience exports for common features

YatingMusic · Nov 21, 2023 · b467678 · b467678
1 parent b196a5a
commit b467678
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ pip install miditoolkit
 ## Example Usage
 
 ```python
-from miditoolkit.midi.parser import MidiFile
+from miditoolkit import MidiFile
 from miditoolkit.midi.utils import example_midi_file
 
 path_midi = example_midi_file()

diff --git a/miditoolkit/__init__.py b/miditoolkit/__init__.py
@@ -3,7 +3,34 @@
 Update date: 2020.06.23
 """
 
-from .midi import *
-from .pianoroll import *
-
 __version__ = "1.0.1"
+
+# Convenience exports for commonly used classes.
+
+from miditoolkit.midi.parser import MidiFile
+from miditoolkit.midi.containers import (
+    ControlChange,
+    Instrument,
+    KeySignature,
+    Lyric,
+    Marker,
+    Note,
+    Pedal,
+    PitchBend,
+    TempoChange,
+    TimeSignature,
+)
+
+__all__ = [
+    "ControlChange",
+    "Instrument",
+    "KeySignature",
+    "Lyric",
+    "Marker",
+    "MidiFile",
+    "Note",
+    "Pedal",
+    "PitchBend",
+    "TempoChange",
+    "TimeSignature",
+]
diff --git a/miditoolkit/pianoroll/__init__.py b/miditoolkit/pianoroll/__init__.py
@@ -0,0 +1,8 @@
+from .parser import notes2pianoroll, pianoroll2notes
+
+# Convenience re-exports
+
+__all__ = [
+    "notes2pianoroll",
+    "pianoroll2notes",
+]
diff --git a/tests/test_pianoroll.py b/tests/test_pianoroll.py
@@ -6,10 +6,12 @@
 
 from pathlib import Path
 
-from miditoolkit import MidiFile, notes2pianoroll, pianoroll2notes
+from miditoolkit import MidiFile
 from miditoolkit.constants import PITCH_RANGE
 from tqdm import tqdm
 
+from miditoolkit.pianoroll import notes2pianoroll, pianoroll2notes
+
 
 def test_pianoroll():
     midi_paths = list(Path("tests", "testcases").glob("**/*.mid"))