sung 0.0.2__tar.gz

sung-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sung-0.0.2/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: sung
+Version: 0.0.2
+Summary: Music data access
+Home-page: https://github.com/thorwhalen/sung
+Author: Thor Whalen
+License: mit
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: spotipy
+Requires-Dist: tabled
+Requires-Dist: glom
+
+# sung
+
+Music data access. Mainly sources from spotify and wikipedia.
+
+To install:	```pip install sung```
+
+
+# Examples
+
+```python
+>>> from sung import search_tracks
+>>> search_tracks('Autumn leaves', limit=3, genre='jazz')  # doctest: +ELLIPSIS
+```

sung-0.0.2/README.md

@@ -0,0 +1,13 @@
+# sung
+
+Music data access. Mainly sources from spotify and wikipedia.
+
+To install:	```pip install sung```
+
+
+# Examples
+
+```python
+>>> from sung import search_tracks
+>>> search_tracks('Autumn leaves', limit=3, genre='jazz')  # doctest: +ELLIPSIS
+```

sung-0.0.2/setup.cfg

@@ -0,0 +1,28 @@
+[metadata]
+name = sung
+version = 0.0.2
+url = https://github.com/thorwhalen/sung
+platforms = any
+description_file = README.md
+root_url = https://github.com/thorwhalen/
+license = mit
+author = Thor Whalen
+description = Music data access
+long_description = file:README.md
+long_description_content_type = text/markdown
+keywords = 
+display_name = sung
+
+[options]
+packages = find:
+include_package_data = True
+zip_safe = False
+install_requires = 
+	spotipy
+	tabled
+	glom
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sung-0.0.2/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()  # Note: Everything should be in the local setup.cfg

sung-0.0.2/sung/__init__.py

@@ -0,0 +1,10 @@
+"""
+Tools to get music metadata (from Spotify, Wikipedia, etc.)
+
+>>> from sung import search_tracks
+>>> search_tracks('Autumn leaves', limit=3, genre='jazz')  # doctest: +ELLIPSIS
+
+"""
+
+from sung.base import search_tracks, track_metadata
+from sung.util import extractor

sung-0.0.2/sung/base.py

@@ -0,0 +1,102 @@
+"""Base functionalities for the sung package."""
+
+from typing import Callable
+from operator import itemgetter
+from sung.util import get_spotify_client, ensure_client, DFLT_LIMIT, extractor
+
+
+# TODO: Include all modifiers in the signature (only year and genre for now)?
+# TODO: Make signature using Spotify.search signature
+def search_tracks(
+    query: str,
+    egress: Callable = extractor('tracks.items'),
+    *,
+    search_type='track',
+    market=None,
+    year=None,
+    genre=None,
+    limit: int = DFLT_LIMIT,
+    offset: int = 0,
+    client=get_spotify_client,
+):
+    """
+    Search for tracks on Spotify.
+
+    Parameters:
+        - query - the search query (see how to write a query in the
+                official documentation https://developer.spotify.com/documentation/web-api/reference/search/)  # noqa
+        - search_type - the types of items to return. One or more of 'artist', 'album',
+                    'track', 'playlist', 'show', and 'episode'.  If multiple types are desired,
+                    pass in a comma separated string; e.g., 'track,album,episode'.
+        - market - An ISO 3166-1 alpha-2 country code or the string
+                    from_token.
+        - limit - the number of items to return (min = 1, default = 10, max = 50). The limit is applied
+                    within each type, not on the total response.
+        - offset - the index of the first item to return
+
+    """
+    client = ensure_client(client)
+
+    # Build query
+    # TODO: Make function using spotify_search_modifiers to do this
+    query_string = query
+    if year:
+        query_string += f" year:{year}"
+    if genre:
+        query_string += f" genre:{genre}"
+
+    # Execute search
+    results = client.search(
+        q=query_string, type=search_type, market=market, limit=limit, offset=offset
+    )
+
+    # Extract tracks and return a list of song names with additional details
+
+    # return map(egress, results)
+    return egress(results)
+    # if 'tracks' in results:
+    #     for item in results['tracks']['items']:
+    #         yield item
+
+
+track_spec = {
+    'name': 'name',
+    'artist': ('artists', [0, 'name']),
+    'album': 'album.name',
+    'release_date': 'album.release_date',
+    'duration_ms': 'duration_ms',
+    'popularity': 'popularity',
+    'explicit': 'explicit',
+    'external_url': 'external_urls.spotify',
+    'preview_url': 'preview_url',
+    'track_number': 'track_number',
+    'album_total_tracks': 'album.total_tracks',
+    'available_markets': 'available_markets',
+    'album_images': 'album.images',
+}
+
+
+def track_metadata(track_id, *, client=get_spotify_client):
+    client = ensure_client(client)
+
+    # Get track details
+    track = client.track(track_id)
+
+    # Prepare metadata dictionary
+    metadata = {
+        'name': track['name'],
+        'artist': track['artists'][0]['name'],
+        'album': track['album']['name'],
+        'release_date': track['album']['release_date'],
+        'duration_ms': track['duration_ms'],
+        'popularity': track['popularity'],
+        'explicit': track['explicit'],
+        'external_url': track['external_urls']['spotify'],
+        'preview_url': track['preview_url'],  # 30s preview if available
+        'track_number': track['track_number'],
+        'album_total_tracks': track['album']['total_tracks'],
+        'available_markets': track['available_markets'],
+        'album_images': track['album']['images'],
+    }
+
+    return metadata

sung-0.0.2/sung/util.py

@@ -0,0 +1,69 @@
+"""Utility functions for the sung package."""
+
+# TODO: use openAPI definition to create pydantic models for data
+#  see https://github.com/thorwhalen/sung/discussions/1#discussioncomment-10990012
+
+from typing import Literal, T, Callable, TypeVar
+from functools import partial
+from spotipy import Spotify
+from spotipy.oauth2 import SpotifyClientCredentials
+from glom import glom, Spec
+
+import os
+
+DFLT_LIMIT = 20
+
+# TODO: Get automatically from pydantic model when available
+SearchTypeT = Literal['artist', 'album', 'track', 'playlist', 'show', 'episode']
+
+
+def identity(x: T) -> T:
+    return x
+
+
+Extractor = TypeVar('Extractor', bound=Callable)  # TODO: Specify more precisely
+
+
+def extractor(spec: Spec) -> Extractor:
+    return partial(glom, spec=spec)
+
+
+def get_config(config_name: str) -> str:
+    """Get the value of a configuration variable."""
+    if config_name in os.environ:
+        return os.environ[config_name]
+    else:
+        raise ValueError(
+            f"Configuration variable {config_name} not found. "
+            "Please set it in the environment. To get your Spotify API credentials, "
+            "see https://developer.spotify.com/documentation/web-api/tutorials/getting-started"
+        )
+
+
+def get_spotify_client() -> Spotify:
+    return Spotify(
+        auth_manager=SpotifyClientCredentials(
+            client_id=get_config('SPOTIFY_API_CLIENT_ID'),
+            client_secret=get_config('SPOTIFY_API_CLIENT_SECRET'),
+        )
+    )
+
+
+spotify_search_modifiers = {
+    "album:": "Search within album titles.",
+    "artist:": "Search within artist names.",
+    "genre:": "Restrict search results to a specific genre. Example: genre:jazz.",
+    "track:": "Search within track names.",
+    "year:": "Filter by release year. Accepts ranges (e.g., year:2000-2020).",
+    "tag:new": "Search for newly released songs.",
+    "tag:hipster": "Search for music outside the mainstream (less popular).",
+    "isrc:": "Search using the International Standard Recording Code.",
+    "upc:": "Search using the Universal Product Code.",
+}
+
+
+def ensure_client(client) -> Spotify:
+    if callable(client):
+        client_factory = client
+        client = client_factory()
+    return client

sung-0.0.2/sung.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: sung
+Version: 0.0.2
+Summary: Music data access
+Home-page: https://github.com/thorwhalen/sung
+Author: Thor Whalen
+License: mit
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: spotipy
+Requires-Dist: tabled
+Requires-Dist: glom
+
+# sung
+
+Music data access. Mainly sources from spotify and wikipedia.
+
+To install:	```pip install sung```
+
+
+# Examples
+
+```python
+>>> from sung import search_tracks
+>>> search_tracks('Autumn leaves', limit=3, genre='jazz')  # doctest: +ELLIPSIS
+```

sung-0.0.2/sung.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+sung/__init__.py
+sung/base.py
+sung/util.py
+sung.egg-info/PKG-INFO
+sung.egg-info/SOURCES.txt
+sung.egg-info/dependency_links.txt
+sung.egg-info/not-zip-safe
+sung.egg-info/requires.txt
+sung.egg-info/top_level.txt

sung-0.0.2/sung.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sung-0.0.2/sung.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

sung-0.0.2/sung.egg-info/requires.txt

@@ -0,0 +1,3 @@
+spotipy
+tabled
+glom

sung-0.0.2/sung.egg-info/top_level.txt

@@ -0,0 +1 @@
+sung