lexicon-python 0.1.0__tar.gz

lexicon_python-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Garrison Burger
+
+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.

lexicon_python-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: lexicon-python
+Version: 0.1.0
+Summary: Python client for the Lexicon DJ API
+Author-email: Garrison Burger <burgerga123@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/photonicvelocity/lexicon-python
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31
+Requires-Dist: tqdm>=4.0
+Dynamic: license-file
+
+# lexicon-python
+
+A lightweight Python client for the [Lexicon DJ](https://www.lexicondj.com/) API.  It wraps the REST endpoints used for playlist browsing and track lookups, while staying simple enough to embed inside scripts or larger automation projects.
+
+## Features
+
+- Class `LexiconClient` with configurable host/port.
+- All GET requests for Playlists, Tracks, and Tags available
+- Handy helpers:
+    - Interactive `choose_playlist` prompt for fast CLI workflows.
+    - GET for all tracks can automatically retrieve all pages with `get_all`
+    - Batch function `get_track_batch` can retrieve full metadata for a list of tracks (including progress bar
+    for large retrievals)
+- Minimal dependencies (`requests`, `tqdm`) and a pure-Python implementation suitable for scripts or larger apps.
+
+## Quickstart
+
+1. Create a virtual environment and install requirements:
+
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   pip install -r requirements.txt
+   ```
+
+2. Run the example script (ensure your Lexicon instance is reachable):
+
+   ```bash
+   python examples/demo_lexicon.py
+   ```
+
+   The script prompts you to choose a playlist, then fetches metadata for the first five tracks.
+
+## Usage
+
+```python
+from lexicon import LexiconClient
+
+lexicon = LexiconClient()
+
+# Choose playlist interactively and fetch it's tracks
+selection = lexicon.choose_playlist(show_counts=True)
+if selection:
+    path, playlist = selection
+    print("Selected:", " / ".join(path))
+    track_ids = set(playlist.get("trackIds", []))
+    print("Tracks reported: ", len(track_ids))
+
+    tracks = lexicon.get_track_batch(track_ids, max_workers=5)
+    for track in tracks:
+        print(track["title"], "-", track["artist"])
+else:
+    print("No playlist selected.")
+
+# Fetch the complete library in chunks of 250
+tracks = lexicon.get_tracks(limit=250, get_all=True) or []
+print(f"Fetched {len(tracks)} tracks")
+
+# Search within your library
+results = lexicon.search_tracks({"artist": "Daft Punk", "bpm": ">=120"}) or []
+print(f"Found {len(results)} matching tracks")
+
+# Inspect tags and categories
+tags_payload = lexicon.get_tags()
+    if tags_payload:
+        for category in tags_payload["categories"]:
+            print("Category:", category["label"])
+            for tag_id in category["tags"]:
+                tag = next((t for t in tags_payload["tags"] if t["id"] == tag_id), None)
+                print("->", tag["label"])
+```
+
+See `examples/demo_lexicon.py` for a more complete walkthrough.
+
+## Development
+
+- Run the test suite: `PYTHONPATH=src python -m unittest discover -s tests`
+- Style: keep the package pure Python, logging via `logging.getLogger(__name__)`, and prefer small, testable helpers.
+- Packaging metadata lives in `pyproject.toml` (see below).
+
+Contributions welcome—open an issue or PR with ideas!

lexicon_python-0.1.0/README.md

@@ -0,0 +1,81 @@
+# lexicon-python
+
+A lightweight Python client for the [Lexicon DJ](https://www.lexicondj.com/) API.  It wraps the REST endpoints used for playlist browsing and track lookups, while staying simple enough to embed inside scripts or larger automation projects.
+
+## Features
+
+- Class `LexiconClient` with configurable host/port.
+- All GET requests for Playlists, Tracks, and Tags available
+- Handy helpers:
+    - Interactive `choose_playlist` prompt for fast CLI workflows.
+    - GET for all tracks can automatically retrieve all pages with `get_all`
+    - Batch function `get_track_batch` can retrieve full metadata for a list of tracks (including progress bar
+    for large retrievals)
+- Minimal dependencies (`requests`, `tqdm`) and a pure-Python implementation suitable for scripts or larger apps.
+
+## Quickstart
+
+1. Create a virtual environment and install requirements:
+
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   pip install -r requirements.txt
+   ```
+
+2. Run the example script (ensure your Lexicon instance is reachable):
+
+   ```bash
+   python examples/demo_lexicon.py
+   ```
+
+   The script prompts you to choose a playlist, then fetches metadata for the first five tracks.
+
+## Usage
+
+```python
+from lexicon import LexiconClient
+
+lexicon = LexiconClient()
+
+# Choose playlist interactively and fetch it's tracks
+selection = lexicon.choose_playlist(show_counts=True)
+if selection:
+    path, playlist = selection
+    print("Selected:", " / ".join(path))
+    track_ids = set(playlist.get("trackIds", []))
+    print("Tracks reported: ", len(track_ids))
+
+    tracks = lexicon.get_track_batch(track_ids, max_workers=5)
+    for track in tracks:
+        print(track["title"], "-", track["artist"])
+else:
+    print("No playlist selected.")
+
+# Fetch the complete library in chunks of 250
+tracks = lexicon.get_tracks(limit=250, get_all=True) or []
+print(f"Fetched {len(tracks)} tracks")
+
+# Search within your library
+results = lexicon.search_tracks({"artist": "Daft Punk", "bpm": ">=120"}) or []
+print(f"Found {len(results)} matching tracks")
+
+# Inspect tags and categories
+tags_payload = lexicon.get_tags()
+    if tags_payload:
+        for category in tags_payload["categories"]:
+            print("Category:", category["label"])
+            for tag_id in category["tags"]:
+                tag = next((t for t in tags_payload["tags"] if t["id"] == tag_id), None)
+                print("->", tag["label"])
+```
+
+See `examples/demo_lexicon.py` for a more complete walkthrough.
+
+## Development
+
+- Run the test suite: `PYTHONPATH=src python -m unittest discover -s tests`
+- Style: keep the package pure Python, logging via `logging.getLogger(__name__)`, and prefer small, testable helpers.
+- Packaging metadata lives in `pyproject.toml` (see below).
+
+Contributions welcome—open an issue or PR with ideas!

lexicon_python-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "lexicon-python"
+version = "0.1.0"
+description = "Python client for the Lexicon DJ API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+authors = [
+  {name = "Garrison Burger", email = "burgerga123@gmail.com"}
+]
+dependencies = [
+  "requests>=2.31",
+  "tqdm>=4.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/photonicvelocity/lexicon-python"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}

lexicon_python-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lexicon_python-0.1.0/src/lexicon/__init__.py

@@ -0,0 +1,5 @@
+"""Public package surface for the lexicon Python client."""
+
+from .lexicon import LexiconClient
+
+__all__ = ["LexiconClient"]