Remove star-imports

README.md

@@ -51,14 +51,17 @@ pip install miditoolkit
 ## Example Usage
 
 ```python
-import miditoolkit
-path_midi = miditoolkit.midi.utils.example_midi_file()
-midi_obj = miditoolkit.midi.parser.MidiFile(path_midi)
+from miditoolkit import MidiFile
+from miditoolkit.midi.utils import example_midi_file
+
+path_midi = example_midi_file()
+midi_obj = MidiFile(path_midi)
+
 print(midi_obj)
+```
 
-"""
 Output:
-
+```
 ticks per beat: 480
 max tick: 72002
 tempo changes: 68
@@ -67,8 +70,6 @@ key sig: 0
 markers: 71
 lyrics: False
 instruments: 2
-
-"""
 ```
 A. [Parse and create MIDI files](examples/parse_and_create_MIDI_files.ipynb)  
 B. [Piano-roll Manipulation](examples/pinoroll_manipulation.ipynb)

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",
+]

miditoolkit/midi/__init__.py

@@ -1,5 +0,0 @@
-from .containers import *
-from .parser import *
-from .utils import *
-
-__all__ = [_ for _ in dir() if not _.startswith("_")]

miditoolkit/pianoroll/__init__.py

@@ -1,5 +1,8 @@
-from .parser import *
-from .utils import *
-from .vis import *
+from .parser import notes2pianoroll, pianoroll2notes
 
-__all__ = [_ for _ in dir() if not _.startswith("_")]
+# Convenience re-exports
+
+__all__ = [
+    "notes2pianoroll",
+    "pianoroll2notes",
+]

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"))