complete restructure + remove named args on __call__ (#49)

* complete restructure + remove named args on __call__ * update release history * update json schema file * update logging config
geo-martino · Mar 29, 2024 · 4ca7de1 · 4ca7de1
1 parent 0ac030d
commit 4ca7de1
Show file tree

Hide file tree

Showing 185 changed files with 1,250 additions and 1,294 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,8 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
 > Libraries log info about loaded objects to the custom `STAT` level.
 > ```python
 > import logging
-> from musify.shared.logger import STAT
+> from musify.log import STAT
+> 
 > logging.basicConfig(format="%(message)s", level=STAT)
 > ```
 
@@ -80,7 +81,7 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
    > The scopes listed in this example will allow access to read your library data and write to your playlists.
    > See Spotify Web API documentation for more information about [scopes](https://developer.spotify.com/documentation/web-api/concepts/scopes)
    ```python
-   from musify.spotify.api import SpotifyAPI
+   from musify.libraries.remote.spotify.api import SpotifyAPI
    
    api = SpotifyAPI(
        client_id="<YOUR CLIENT ID>",
@@ -103,7 +104,7 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
    ```
 4. Create a `SpotifyLibrary` object and load your library data as follows:
    ```python
-   from musify.spotify.library import SpotifyLibrary
+   from musify.libraries.remote.spotify.library import SpotifyLibrary
    
    library = SpotifyLibrary(api=api)
    
@@ -133,7 +134,7 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
    ```
 5. Load some Spotify objects using any of the supported identifiers as follows:
    ```python
-   from musify.spotify.object import SpotifyTrack, SpotifyAlbum, SpotifyPlaylist, SpotifyArtist
+   from musify.libraries.remote.spotify.object import SpotifyTrack, SpotifyAlbum, SpotifyPlaylist, SpotifyArtist
    
    # load by ID
    track1 = SpotifyTrack.load("6fWoFduMpBem73DMLCOh1Z", api=api)
@@ -181,7 +182,7 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
 
    #### Generic local library
    ```python
-   from musify.local.library import LocalLibrary
+   from musify.libraries.local.library import LocalLibrary
 
    library = LocalLibrary(
        library_folders=["<PATH TO YOUR LIBRARY FOLDER>", ...],
@@ -191,7 +192,7 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
 
    #### MusicBee
    ```python
-   from musify.local.library import MusicBee
+   from musify.libraries.local.library import MusicBee
 
    library = MusicBee(musicbee_folder="<PATH TO YOUR MUSICBEE FOLDER>")
    ```
@@ -228,7 +229,8 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
 4. Get a track from your library using any of the following identifiers:
    ```python
    # get a track via its title
-   track = library["<TRACK TITLE>"]  # if multiple tracks have the same title, the first matching one if returned
+   # if multiple tracks have the same title, the first matching one if returned
+   track = library["<TRACK TITLE>"]
 
    # get a track via its path
    track = library["<PATH TO YOUR TRACK>"]  # must be an absolute path
@@ -265,7 +267,7 @@ For more detailed guides, check out the [documentation](https://geo-martino.gith
 
 6. Save the tags to the file:
    ```python
-   from musify.local.track.field import LocalTrackField
+   from musify.libraries.local.track.field import LocalTrackField
 
    # you don't have to save all the tags you just modified
    # select which you wish to save first like so

diff --git a/README.template.md b/README.template.md
@@ -59,7 +59,8 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
 > Libraries log info about loaded objects to the custom `STAT` level.
 > ```python
 > import logging
-> from musify.shared.logger import STAT
+> from musify.log import STAT
+> 
 > logging.basicConfig(format="%(message)s", level=STAT)
 > ```
 
@@ -80,7 +81,7 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
    > The scopes listed in this example will allow access to read your library data and write to your playlists.
    > See Spotify Web API documentation for more information about [scopes](https://developer.spotify.com/documentation/web-api/concepts/scopes)
    ```python
-   from musify.spotify.api import SpotifyAPI
+   from musify.libraries.remote.spotify.api import SpotifyAPI
    
    api = SpotifyAPI(
        client_id="<YOUR CLIENT ID>",
@@ -103,7 +104,7 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
    ```
 4. Create a `SpotifyLibrary` object and load your library data as follows:
    ```python
-   from musify.spotify.library import SpotifyLibrary
+   from musify.libraries.remote.spotify.library import SpotifyLibrary
    
    library = SpotifyLibrary(api=api)
    
@@ -133,7 +134,7 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
    ```
 5. Load some Spotify objects using any of the supported identifiers as follows:
    ```python
-   from musify.spotify.object import SpotifyTrack, SpotifyAlbum, SpotifyPlaylist, SpotifyArtist
+   from musify.libraries.remote.spotify.object import SpotifyTrack, SpotifyAlbum, SpotifyPlaylist, SpotifyArtist
    
    # load by ID
    track1 = SpotifyTrack.load("6fWoFduMpBem73DMLCOh1Z", api=api)
@@ -181,7 +182,7 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
 
    #### Generic local library
    ```python
-   from musify.local.library import LocalLibrary
+   from musify.libraries.local.library import LocalLibrary
 
    library = LocalLibrary(
        library_folders=["<PATH TO YOUR LIBRARY FOLDER>", ...],
@@ -191,7 +192,7 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
 
    #### MusicBee
    ```python
-   from musify.local.library import MusicBee
+   from musify.libraries.local.library import MusicBee
 
    library = MusicBee(musicbee_folder="<PATH TO YOUR MUSICBEE FOLDER>")
    ```
@@ -228,7 +229,8 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
 4. Get a track from your library using any of the following identifiers:
    ```python
    # get a track via its title
-   track = library["<TRACK TITLE>"]  # if multiple tracks have the same title, the first matching one if returned
+   # if multiple tracks have the same title, the first matching one if returned
+   track = library["<TRACK TITLE>"]
 
    # get a track via its path
    track = library["<PATH TO YOUR TRACK>"]  # must be an absolute path
@@ -265,7 +267,7 @@ For more detailed guides, check out the [documentation](https://{program_owner_u
 
 6. Save the tags to the file:
    ```python
-   from musify.local.track.field import LocalTrackField
+   from musify.libraries.local.track.field import LocalTrackField
 
    # you don't have to save all the tags you just modified
    # select which you wish to save first like so

diff --git a/docs/_howto/scripts/local.library.backup-restore.py b/docs/_howto/scripts/local.library.backup-restore.py
@@ -1,4 +1,4 @@
-from musify.local.library import LocalLibrary
+from musify.libraries.local.library import LocalLibrary
 library = LocalLibrary()
 
 import json
@@ -13,7 +13,7 @@
 
 library.restore_tracks(tracks)
 
-from musify.local.track.field import LocalTrackField
+from musify.libraries.local.track.field import LocalTrackField
 
 tags = [
     LocalTrackField.TITLE,

diff --git a/docs/_howto/scripts/local.library.load.py b/docs/_howto/scripts/local.library.load.py
@@ -1,11 +1,11 @@
-from musify.local.library import LocalLibrary
+from musify.libraries.local.library import LocalLibrary
 
 library = LocalLibrary(
     library_folders=["<PATH TO YOUR LIBRARY FOLDER>", ...],
     playlist_folder="<PATH TO YOUR PLAYLIST FOLDER>",
 )
 
-from musify.local.library import MusicBee
+from musify.libraries.local.library import MusicBee
 
 library = MusicBee(musicbee_folder="<PATH TO YOUR MUSICBEE FOLDER>")
 

diff --git a/docs/_howto/scripts/local.playlist.load-save.py b/docs/_howto/scripts/local.playlist.load-save.py
@@ -1,5 +1,5 @@
-from musify.local.playlist import M3U, XAutoPF
-from musify.local.track import load_track
+from musify.libraries.local.playlist import M3U, XAutoPF
+from musify.libraries.local.track import load_track
 
 tracks = [
     load_track("<PATH TO A TRACK>"),
@@ -16,11 +16,11 @@
 # pretty print information about this playlist
 print(playlist)
 
-from musify.local.playlist import load_playlist
+from musify.libraries.local.playlist import load_playlist
 
 playlist = load_playlist("<PATH TO A PLAYLIST>")
 
-from musify.local.track import load_track
+from musify.libraries.local.track import load_track
 
 tracks = [
     load_track("<PATH TO A TRACK>"),
@@ -31,11 +31,11 @@
 
 playlist = M3U("<PATH TO AN M3U PLAYLIST>", tracks=tracks)
 
-from musify.shared.file import PathMapper
+from musify.file.path_mapper import PathMapper
 
 playlist = M3U("<PATH TO AN M3U PLAYLIST>", path_mapper=PathMapper())
 
-from musify.spotify.processors import SpotifyDataWrangler
+from musify.libraries.remote.spotify.processors import SpotifyDataWrangler
 
 playlist = M3U("<PATH TO AN M3U PLAYLIST>", remote_wrangler=SpotifyDataWrangler())
 

diff --git a/docs/_howto/scripts/local.track.load-save.py b/docs/_howto/scripts/local.track.load-save.py
@@ -1,4 +1,4 @@
-from musify.local.track import FLAC, MP3, M4A, WMA
+from musify.libraries.local.track import FLAC, MP3, M4A, WMA
 
 track = FLAC("<PATH TO A FLAC TRACK>")
 track = MP3("<PATH TO AN MP3 TRACK>")
@@ -8,11 +8,11 @@
 # pretty print information about this track
 print(track)
 
-from musify.local.track import load_track
+from musify.libraries.local.track import load_track
 
 track = load_track("<PATH TO AN MP3 TRACK>")
 
-from musify.spotify.processors import SpotifyDataWrangler
+from musify.libraries.remote.spotify.processors import SpotifyDataWrangler
 
 track = MP3("<PATH TO AN MP3 TRACK>", remote_wrangler=SpotifyDataWrangler())
 
@@ -39,7 +39,7 @@
 results = track.save(replace=True, dry_run=False)
 
 # ...or select which tags you wish to save like so
-from musify.local.track.field import LocalTrackField
+from musify.libraries.local.track.field import LocalTrackField
 
 tags = [
     LocalTrackField.TITLE,

diff --git a/docs/_howto/scripts/remote.new-music.py b/docs/_howto/scripts/remote.new-music.py
@@ -1,5 +1,5 @@
-from musify.spotify.api import SpotifyAPI
-from musify.spotify.library import SpotifyLibrary
+from musify.libraries.remote.spotify.api import SpotifyAPI
+from musify.libraries.remote.spotify.library import SpotifyLibrary
 api = SpotifyAPI()
 library = SpotifyLibrary(api=api)
 
@@ -23,7 +23,7 @@ def match_date(alb) -> bool:
     return False
 
 
-from musify.shared.remote.enum import RemoteObjectType
+from musify.libraries.remote.core.enum import RemoteObjectType
 
 albums = [album for artist in library.artists for album in artist.albums if match_date(album)]
 albums_need_extend = [album for album in albums if len(album.tracks) < album.track_total]
@@ -39,7 +39,7 @@ def match_date(alb) -> bool:
 # log stats about the loaded artists
 library.log_artists()
 
-from musify.spotify.object import SpotifyPlaylist
+from musify.libraries.remote.spotify.object import SpotifyPlaylist
 
 name = "New Music Playlist"
 playlist = SpotifyPlaylist.create(api=api, name=name)

diff --git a/docs/_howto/scripts/reports.py b/docs/_howto/scripts/reports.py
@@ -1,16 +1,16 @@
-from musify.local.library import LocalLibrary
+from musify.libraries.local.library import LocalLibrary
 local_library = LocalLibrary()
 
-from musify.spotify.api import SpotifyAPI
-from musify.spotify.library import SpotifyLibrary
+from musify.libraries.remote.spotify.api import SpotifyAPI
+from musify.libraries.remote.spotify.library import SpotifyLibrary
 api = SpotifyAPI()
 remote_library = SpotifyLibrary(api=api)
 
 from musify.report import report_playlist_differences
 
 report_playlist_differences(source=local_library, reference=remote_library)
 
-from musify.local.track.field import LocalTrackField
+from musify.libraries.local.track.field import LocalTrackField
 from musify.report import report_missing_tags
 
 tags = [

diff --git a/docs/_howto/scripts/setup.py b/docs/_howto/scripts/setup.py
@@ -1,4 +1,4 @@
 import logging
-from musify.shared.logger import STAT
+from musify.log import STAT
 
 logging.basicConfig(format="%(message)s", level=STAT)
diff --git a/docs/_howto/scripts/spotify.api.py b/docs/_howto/scripts/spotify.api.py
@@ -1,4 +1,4 @@
-from musify.spotify.api import SpotifyAPI
+from musify.libraries.remote.spotify.api import SpotifyAPI
 
 api = SpotifyAPI(
     client_id="<YOUR CLIENT ID>",
@@ -19,5 +19,5 @@
 # authorise the program to access your Spotify data in your web browser
 api.authorise()
 
-from musify.spotify.library import SpotifyLibrary
+from musify.libraries.remote.spotify.library import SpotifyLibrary
 library = SpotifyLibrary(api=api)
diff --git a/docs/_howto/scripts/spotify.library.backup-restore.py b/docs/_howto/scripts/spotify.library.backup-restore.py
@@ -1,5 +1,5 @@
-from musify.spotify.api import SpotifyAPI
-from musify.spotify.library import SpotifyLibrary
+from musify.libraries.remote.spotify.api import SpotifyAPI
+from musify.libraries.remote.spotify.library import SpotifyLibrary
 api = SpotifyAPI()
 library = SpotifyLibrary(api=api)
 

diff --git a/docs/_howto/scripts/spotify.load.py b/docs/_howto/scripts/spotify.load.py
@@ -1,7 +1,7 @@
-from musify.spotify.api import SpotifyAPI
+from musify.libraries.remote.spotify.api import SpotifyAPI
 api = SpotifyAPI()
 
-from musify.spotify.library import SpotifyLibrary
+from musify.libraries.remote.spotify.library import SpotifyLibrary
 
 library = SpotifyLibrary(api=api)
 
@@ -29,7 +29,7 @@
 # pretty print an overview of your library
 print(library)
 
-from musify.spotify.object import SpotifyTrack, SpotifyAlbum, SpotifyPlaylist, SpotifyArtist
+from musify.libraries.remote.spotify.object import SpotifyTrack, SpotifyAlbum, SpotifyPlaylist, SpotifyArtist
 
 # load by ID
 track1 = SpotifyTrack.load("6fWoFduMpBem73DMLCOh1Z", api=api)

diff --git a/docs/_howto/scripts/sync.py b/docs/_howto/scripts/sync.py
@@ -1,8 +1,8 @@
-from musify.spotify.api import SpotifyAPI
+from musify.libraries.remote.spotify.api import SpotifyAPI
 api = SpotifyAPI()
 
-from musify.local.library import LocalLibrary
-from musify.spotify.processors import SpotifyDataWrangler
+from musify.libraries.local.library import LocalLibrary
+from musify.libraries.remote.spotify.processors import SpotifyDataWrangler
 
 local_library = LocalLibrary(
     library_folders=["<PATH TO YOUR LIBRARY FOLDER>", ...],
@@ -12,9 +12,9 @@
 )
 local_library.load()
 
-from musify.shared.remote.processors.search import RemoteItemSearcher
-from musify.shared.remote.processors.check import RemoteItemChecker
-from musify.spotify.factory import SpotifyObjectFactory
+from musify.libraries.remote.core.processors.search import RemoteItemSearcher
+from musify.libraries.remote.core.processors.check import RemoteItemChecker
+from musify.libraries.remote.spotify.factory import SpotifyObjectFactory
 
 albums = local_library.albums[:3]
 factory = SpotifyObjectFactory(api=api)
@@ -25,7 +25,7 @@
 checker = RemoteItemChecker(object_factory=factory)
 checker.check(albums)
 
-from musify.spotify.object import SpotifyTrack
+from musify.libraries.remote.spotify.object import SpotifyTrack
 
 for album in albums:
     for local_track in album:
@@ -46,7 +46,7 @@
     # ...save all tracks on the album at once here
     album.save_tracks(replace=True, dry_run=False)
 
-from musify.spotify.library import SpotifyLibrary
+from musify.libraries.remote.spotify.library import SpotifyLibrary
 
 remote_library = SpotifyLibrary(api=api)
 remote_library.load_playlists()

diff --git a/docs/index.rst b/docs/index.rst
@@ -61,9 +61,15 @@ Install through pip using one of the following commands:
    :maxdepth: 1
    :caption: 📖 Reference
 
-   musify.local
+   musify.api
+   musify.core
+   musify.file
+   musify.libraries
+   musify.log
    musify.processors
-   musify.shared
-   musify.spotify
+   musify.exception
+   musify.field
    musify.report
+   musify.types
+   musify.utils
    genindex