py-music-assistant 0.0.1__tar.gz

py_music_assistant-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

py_music_assistant-0.0.1/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: py-music-assistant
+Version: 0.0.1
+Summary: Python HTTP client and mediavocab bridge for a Music Assistant server
+Author-email: JarbasAI <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/py-music-assistant
+Project-URL: Source, https://github.com/TigreGotico/py-music-assistant
+Keywords: music-assistant,mediavocab,ovos,OpenVoiceOS,OCP,media
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: ovos-utils>=0.0.38
+Requires-Dist: mediavocab>=1.0.0
+Requires-Dist: music-assistant-models>=1.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# py-music-assistant
+
+Python HTTP client and [mediavocab](https://github.com/TigreGotico/mediavocab)
+bridge for a [Music Assistant](https://www.music-assistant.io/) server.
+
+It is the single transport + conversion layer shared by the OVOS Music Assistant
+integrations:
+
+- **[ovos-media-plugin-mass](https://github.com/OpenVoiceOS/ovos-media-plugin-mass)** — playback backend (`opm.media.audio`)
+- **[ovos-media-provider-mass](https://github.com/OpenVoiceOS/ovos-media-provider-mass)** — catalog/search provider (`opm.media.provider`)
+- **[ovos-skill-music-assistant](https://github.com/OpenVoiceOS/ovos-skill-music-assistant)** — legacy OCP search skill
+
+## Install
+
+```bash
+pip install py-music-assistant
+```
+
+## Usage
+
+```python
+from py_music_assistant import SimpleHTTPMusicAssistantClient, search_to_releases
+
+api = SimpleHTTPMusicAssistantClient("http://192.168.1.100:8095")
+
+# raw search (dict of buckets: tracks/albums/artists/radio/podcasts/audiobooks)
+res = api.search_media("viagra boys", limit=10)
+
+# mapped to typed mediavocab.Release objects (unranked; score them yourself)
+releases = search_to_releases(res)
+for r in releases:
+    print(r.work.title, r.work.media_type, r.uri)   # e.g. "Worms" MUSIC library://track/9903
+```
+
+The client talks to the server's synchronous JSON `/api` endpoint (no WebSocket
+lifecycle). Item `uri`s are `library://<type>/<id>` identifiers that the
+`ovos-media-plugin-mass` backend resolves and plays.
+
+## Docs
+
+- [docs/index.md](docs/index.md) — overview
+- [docs/client-api.md](docs/client-api.md) — `SimpleHTTPMusicAssistantClient` reference
+- [docs/mediavocab-bridge.md](docs/mediavocab-bridge.md) — dict → `Release` mapping
+
+## Tests
+
+```bash
+pip install -e .[test]
+pytest test/                                   # network-free (mocked + fixtures)
+MASS_SERVER_URL=http://<host>:8095 pytest test/live/   # opt-in, against a real server
+```
+
+## License
+
+Apache-2.0

py_music_assistant-0.0.1/README.md

@@ -0,0 +1,55 @@
+# py-music-assistant
+
+Python HTTP client and [mediavocab](https://github.com/TigreGotico/mediavocab)
+bridge for a [Music Assistant](https://www.music-assistant.io/) server.
+
+It is the single transport + conversion layer shared by the OVOS Music Assistant
+integrations:
+
+- **[ovos-media-plugin-mass](https://github.com/OpenVoiceOS/ovos-media-plugin-mass)** — playback backend (`opm.media.audio`)
+- **[ovos-media-provider-mass](https://github.com/OpenVoiceOS/ovos-media-provider-mass)** — catalog/search provider (`opm.media.provider`)
+- **[ovos-skill-music-assistant](https://github.com/OpenVoiceOS/ovos-skill-music-assistant)** — legacy OCP search skill
+
+## Install
+
+```bash
+pip install py-music-assistant
+```
+
+## Usage
+
+```python
+from py_music_assistant import SimpleHTTPMusicAssistantClient, search_to_releases
+
+api = SimpleHTTPMusicAssistantClient("http://192.168.1.100:8095")
+
+# raw search (dict of buckets: tracks/albums/artists/radio/podcasts/audiobooks)
+res = api.search_media("viagra boys", limit=10)
+
+# mapped to typed mediavocab.Release objects (unranked; score them yourself)
+releases = search_to_releases(res)
+for r in releases:
+    print(r.work.title, r.work.media_type, r.uri)   # e.g. "Worms" MUSIC library://track/9903
+```
+
+The client talks to the server's synchronous JSON `/api` endpoint (no WebSocket
+lifecycle). Item `uri`s are `library://<type>/<id>` identifiers that the
+`ovos-media-plugin-mass` backend resolves and plays.
+
+## Docs
+
+- [docs/index.md](docs/index.md) — overview
+- [docs/client-api.md](docs/client-api.md) — `SimpleHTTPMusicAssistantClient` reference
+- [docs/mediavocab-bridge.md](docs/mediavocab-bridge.md) — dict → `Release` mapping
+
+## Tests
+
+```bash
+pip install -e .[test]
+pytest test/                                   # network-free (mocked + fixtures)
+MASS_SERVER_URL=http://<host>:8095 pytest test/live/   # opt-in, against a real server
+```
+
+## License
+
+Apache-2.0

py_music_assistant-0.0.1/py_music_assistant/__init__.py

@@ -0,0 +1,29 @@
+"""Python client + mediavocab bridge for a Music Assistant server.
+
+Exposes the synchronous :class:`SimpleHTTPMusicAssistantClient` HTTP client and
+converters that map Music Assistant API dicts into :class:`mediavocab.Release`
+objects, shared by the OVOS Music Assistant integrations.
+"""
+from py_music_assistant.client import (
+    SimpleHTTPMusicAssistantClient,
+    debug_method,
+)
+from py_music_assistant.converters import (
+    PLATFORM,
+    item_to_release,
+    items_to_releases,
+    recently_played_to_releases,
+    search_to_releases,
+)
+from py_music_assistant.version import __version__
+
+__all__ = [
+    "SimpleHTTPMusicAssistantClient",
+    "debug_method",
+    "item_to_release",
+    "items_to_releases",
+    "search_to_releases",
+    "recently_played_to_releases",
+    "PLATFORM",
+    "__version__",
+]

py_music_assistant-0.0.1/py_music_assistant/client.py

@@ -0,0 +1,278 @@
+"""HTTP client for a Music Assistant server's REST API.
+
+A thin, synchronous wrapper over the Music Assistant ``/api`` JSON-RPC-style
+endpoint that avoids the WebSocket client's connection lifecycle. It is the
+single transport shared by the OVOS Music Assistant integrations
+(``ovos-media-plugin-mass`` for playback, ``ovos-media-provider-mass`` for
+catalog search, and the legacy ``ovos-skill-music-assistant``).
+"""
+import functools
+import json
+import uuid
+from typing import Any, Dict, List, Optional
+
+import requests
+from ovos_utils.log import LOG
+
+from music_assistant_models.enums import MediaType, QueueOption
+from music_assistant_models.errors import MusicAssistantError
+from music_assistant_models.player import Player
+
+
+def debug_method(func):
+    """Decorator to log method inputs and outputs for debugging purposes."""
+
+    @functools.wraps(func)
+    def wrapper(self, *args, **kwargs):
+        # Format arguments for logging
+        args_str = ", ".join([repr(arg) for arg in args])
+        kwargs_str = ", ".join([f"{k}={repr(v)}" for k, v in kwargs.items()])
+
+        # Combine args and kwargs for display
+        all_args = []
+        if args_str:
+            all_args.append(args_str)
+        if kwargs_str:
+            all_args.append(kwargs_str)
+        args_display = ", ".join(all_args)
+
+        # Log the method call
+        method_name = f"{self.__class__.__name__}.{func.__name__}"
+        self.log.debug(f"CALL {method_name}({args_display})")
+
+        try:
+            # Execute the function
+            result = func(self, *args, **kwargs)
+
+            # Format result for logging (truncate if too long)
+            if result is None:
+                result_str = "None"
+            elif isinstance(result, (str, int, float, bool)):
+                result_str = repr(result)
+            elif isinstance(result, (list, dict)):
+                result_str = json.dumps(result, default=str, indent=None)
+                if len(result_str) > 200:
+                    result_str = result_str[:200] + "..."
+            else:
+                result_str = f"<{type(result).__name__} object>"
+
+            self.log.debug(f"RETURN {method_name} -> {result_str}")
+            return result
+
+        except Exception as e:
+            self.log.debug(f"ERROR {method_name} -> {type(e).__name__}: {e}")
+            raise
+
+    return wrapper
+
+
+class SimpleHTTPMusicAssistantClient:
+    """Simple HTTP-based Music Assistant client that avoids WebSocket issues."""
+
+    def __init__(self, server_url: str, session: Optional[requests.Session] = None):
+        self.server_url = server_url.rstrip("/")
+        self.api_url = f"{self.server_url}/api"
+        self.session = session or requests.Session()
+        self.log = LOG()
+
+    @debug_method
+    def send_command(self, command: str, **args) -> Any:
+        """Send a command to Music Assistant via HTTP API."""
+        payload = {"command": command, "message_id": uuid.uuid4().hex, "args": args}
+
+        response = self.session.post(self.api_url, json=payload)
+        if response.status_code == 200:
+            return response.json()
+        raise MusicAssistantError(f"HTTP {response.status_code}: {response.text}")
+
+    @debug_method
+    def get_players(self) -> List[Player]:
+        """Get all available players."""
+        result = self.send_command("players/all")
+        return [Player.from_dict(player_data) for player_data in result]
+
+    def search_media(
+        self, query: str, media_types: Optional[List[MediaType]] = None, limit: int = 20
+    ) -> Dict[str, Any]:
+        """Search for media."""
+        args = {"search_query": query, "limit": limit}
+        if media_types:
+            args["media_types"] = [mt.value for mt in media_types]
+        return self.send_command("music/search", **args)
+
+    def track_info(self, uri: str) -> Dict[str, Any]:
+        """Resolve metadata for a single media item by uri."""
+        args = {"uri": uri}
+        return self.send_command("music/item_by_uri", **args)
+
+    def recommendations(self) -> Dict[str, Any]:
+        """Fetch the server's recommendations feed."""
+        return self.send_command("music/recommendations")
+
+    def recently_played(self) -> Dict[str, Any]:
+        """Fetch the server's recently-played items feed."""
+        return self.send_command("music/recently_played_items")
+
+    def play_media(
+        self,
+        queue_id: str,
+        media: str,
+        option: QueueOption = QueueOption.PLAY,  # type: ignore
+        radio_mode: bool = False,
+    ):
+        """Play media on a player queue."""
+        self.log.info(
+            f"Sending play_media: queue_id={queue_id}, media={media}, option={option.value}, "
+            f"radio_mode={radio_mode}"
+        )
+        return self.send_command(
+            command="player_queues/play_media",
+            queue_id=queue_id,
+            media=media,
+            option=option.value,
+            radio_mode=radio_mode,
+        )
+
+    def queue_command_play(self, queue_id: str):
+        """Send PLAY command to given queue."""
+        return self.send_command("player_queues/play", queue_id=queue_id)
+
+    def queue_command_pause(self, queue_id: str):
+        """Pause playback."""
+        return self.send_command("player_queues/play_pause", queue_id=queue_id)
+
+    def queue_command_next(self, queue_id: str):
+        """Skip to next track."""
+        return self.send_command("player_queues/next", queue_id=queue_id)
+
+    def queue_command_previous(self, queue_id: str):
+        """Go to previous track."""
+        return self.send_command("player_queues/previous", queue_id=queue_id)
+
+    def player_command_power_on(self, player_id: str):
+        """Power on a player."""
+        return self.send_command("players/player_command_power_on", player_id=player_id)
+
+    def player_command_power_off(self, player_id: str):
+        """Power off a player."""
+        return self.send_command("players/player_command_power_off", player_id=player_id)
+
+    # Volume control commands
+    def player_command_volume_set(self, player_id: str, volume: int):
+        """Set player volume (0-100)."""
+        return self.send_command("players/cmd/volume_set", player_id=player_id, volume_level=volume)
+
+    def player_command_volume_up(self, player_id: str):
+        """Increase player volume."""
+        return self.send_command("players/cmd/volume_up", player_id=player_id)
+
+    def player_command_volume_down(self, player_id: str):
+        """Decrease player volume."""
+        return self.send_command("players/cmd/volume_down", player_id=player_id)
+
+    def player_command_volume_mute(self, player_id: str, muted: bool = True):
+        """Mute/unmute player."""
+        return self.send_command("players/cmd/volume_mute", player_id=player_id, muted=muted)
+
+    # player controls
+    def player_command_seek(self, player_id: str, position: int) -> None:
+        """Handle SEEK command for given player.
+
+        - player_id: player_id of the player to handle the command.
+        - position: position in seconds to seek to in the current playing item.
+        """
+        return self.send_command("players/cmd/seek", player_id=player_id, position=position)
+
+    def player_command_stop(self, player_id: str) -> None:
+        """Handle STOP command for given player.
+
+        - player_id: player_id of the player to handle the command.
+        """
+        return self.send_command("players/cmd/stop", player_id=player_id)
+
+    # State checking methods
+    def get_player_queue_items(self, queue_id: str, limit: int = 10, offset: int = 0):
+        """Get current queue items for a player."""
+        return self.send_command("player_queues/items", queue_id=queue_id, limit=limit, offset=offset)
+
+    def get_active_queue(self, player_id: str):
+        """Get the current active queue for a player."""
+        return self.send_command("player_queues/get_active_queue", player_id=player_id)
+
+    def _find_player_by_id(self, player_id: str) -> Optional[Player]:
+        """Find a player by ID."""
+        players = self.get_players()
+        for player in players:
+            if player.player_id == player_id:
+                return player
+        return None
+
+    def _extract_playback_state(self, player: Player) -> str:
+        """Extract playback state from player object."""
+        if not hasattr(player, "playback_state"):
+            return "unknown"
+
+        state = player.playback_state
+        return state.value if hasattr(state, "value") else str(state)
+
+    def _extract_track_from_media(self, player: Player) -> Optional[str]:
+        """Extract track name from player's current_media."""
+        if not (hasattr(player, "current_media") and player.current_media):
+            return None
+
+        media = player.current_media
+        if not (hasattr(media, "title") and media.title):
+            return None
+
+        track_name = media.title
+        if hasattr(media, "artist") and media.artist:
+            return f"{media.artist} - {track_name}"
+        return track_name
+
+    def _extract_track_from_queue(self, player: Player) -> Optional[str]:
+        """Extract track name from player's queue items."""
+        if not (hasattr(player, "current_item_id") and player.current_item_id):
+            return None
+
+        try:
+            queue_items = self.get_player_queue_items(player.player_id, limit=1)
+            if not (queue_items and len(queue_items) > 0):
+                return None
+
+            item = queue_items[0]
+            if hasattr(item, "name") and item.name:
+                return item.name
+            if hasattr(item, "media_item") and item.media_item:
+                return getattr(item.media_item, "name", None)
+        except Exception:
+            self.log.exception("Error extracting track from queue, returning None")
+        return None
+
+    def _extract_current_track(self, player: Player) -> str:
+        """Extract current track name with artist info."""
+        track_name = self._extract_track_from_media(player)
+        if track_name:
+            return track_name
+
+        track_name = self._extract_track_from_queue(player)
+        if track_name:
+            return track_name
+
+        return "No track"
+
+    def get_player_state(self, player_id: str):
+        """Get current player state (playing, paused, etc.)."""
+        player = self._find_player_by_id(player_id)
+        if not player:
+            return None
+
+        return {
+            "state": self._extract_playback_state(player),
+            "powered": getattr(player, "powered", True),
+            "volume_level": getattr(player, "volume_level", None),
+            "volume_muted": getattr(player, "volume_muted", False),
+            "current_track": self._extract_current_track(player),
+            "player_name": getattr(player, "name", "Unknown"),
+            "player_type": getattr(player, "provider", "Unknown"),
+            "available": getattr(player, "available", False),
+        }

py_music_assistant-0.0.1/py_music_assistant/converters.py

@@ -0,0 +1,156 @@
+"""Converters from Music Assistant API dicts to mediavocab typed objects.
+
+Music Assistant's ``music/search`` and ``music/recently_played_items`` endpoints
+return media items as plain dicts. Each item carries (among others) ``name``,
+``uri`` (a ``library://<type>/<id>`` identifier the ``ovos-media-plugin-mass``
+playback backend resolves), ``media_type`` (``track``/``album``/``artist``/
+``playlist``/``radio``/``podcast``/``audiobook``), ``is_playable``, ``favorite``,
+an ``artists`` list, an ``album`` object, ``duration`` (seconds) and image data.
+
+This module maps those dicts into :class:`mediavocab.Release` objects so a
+:class:`MediaProvider` can stay a thin shim. Results are returned **unranked**
+(``match_confidence`` left at ``0.0``); the provider scores them against the
+parsed request ``Signals``.
+"""
+from typing import Any, Dict, List, Optional
+
+from mediavocab import MediaType, Release, Work
+
+
+# Music Assistant ``media_type`` string -> mediavocab ``MediaType``.
+_MEDIA_TYPE_MAP: Dict[str, MediaType] = {
+    "track": MediaType.MUSIC,
+    "album": MediaType.MUSIC,
+    "artist": MediaType.MUSIC,
+    "playlist": MediaType.PLAYLIST,
+    "radio": MediaType.RADIO,
+    "podcast": MediaType.PODCAST,
+    "audiobook": MediaType.AUDIOBOOK,
+}
+
+PLATFORM = "music-assistant"
+
+
+def _extract_image(entry: Dict[str, Any]) -> str:
+    """Return the first remotely-accessible image path for an item, or ``""``.
+
+    Music Assistant exposes art either as a top-level ``image`` object or as a
+    list under ``metadata.images``; in both cases an image is only usable when
+    ``remotely_accessible`` is set (a local-only path is unreachable by OVOS).
+    """
+    img = entry.get("image")
+    if isinstance(img, dict) and img.get("path") and img.get("remotely_accessible"):
+        return img["path"]
+    meta = entry.get("metadata") or {}
+    for im in meta.get("images") or []:
+        if isinstance(im, dict) and im.get("path") and im.get("remotely_accessible"):
+            return im["path"]
+    return ""
+
+
+def _extract_artists(entry: Dict[str, Any]) -> List[str]:
+    """Return artist names for an item, guarding against missing/empty fields.
+
+    (The legacy ``load_track`` path crashed on items with no ``artists``/
+    ``album``; the None-guards live here so every consumer benefits.)
+    """
+    if entry.get("media_type") == "artist":
+        name = (entry.get("name") or "").strip()
+        return [name] if name else []
+    out: List[str] = []
+    for a in entry.get("artists") or []:
+        if isinstance(a, dict):
+            n = (a.get("name") or "").strip()
+            if n:
+                out.append(n)
+    return out
+
+
+def item_to_release(entry: Dict[str, Any]) -> Optional[Release]:
+    """Convert a single Music Assistant media-item dict to a :class:`Release`.
+
+    Returns ``None`` for items that are not playable or have no ``uri``/``name``
+    (e.g. an artist identity with no playable radio). ``artist``, ``album`` and
+    ``duration`` are mirrored into ``work.extra`` so a player can render them
+    without a second API call; ``match_confidence`` is left at ``0.0`` for the
+    caller to score.
+    """
+    if not isinstance(entry, dict):
+        return None
+    if not entry.get("is_playable", True):
+        return None
+
+    name = (entry.get("name") or "").strip()
+    uri = (entry.get("uri") or "").strip()
+    if not name or not uri:
+        return None
+
+    media_type = _MEDIA_TYPE_MAP.get(entry.get("media_type"), MediaType.MUSIC)
+
+    external_ids: Dict[str, str] = {}
+    raw_ext = entry.get("external_ids")
+    if isinstance(raw_ext, dict):
+        external_ids = {str(k): str(v) for k, v in raw_ext.items() if v}
+
+    artists = _extract_artists(entry)
+    album = entry.get("album")
+    album_name = album.get("name") if isinstance(album, dict) else None
+
+    work_extra: Dict[str, Any] = {"mass_media_type": entry.get("media_type")}
+    if artists:
+        work_extra["artist"] = " & ".join(artists)
+    if album_name:
+        work_extra["album"] = album_name
+    if entry.get("favorite"):
+        work_extra["favorite"] = True
+    duration = entry.get("duration")
+
+    work = Work(
+        title=name,
+        media_type=media_type,
+        runtime=float(duration) if isinstance(duration, (int, float)) and duration else None,
+        external_ids=dict(external_ids),
+        extra=work_extra,
+    )
+
+    return Release(
+        work=work,
+        uri=uri,
+        image=_extract_image(entry),
+        platform=PLATFORM,
+        match_confidence=0.0,
+        external_ids=dict(external_ids),
+    )
+
+
+def items_to_releases(items: Any) -> List[Release]:
+    """Map a flat iterable of media-item dicts to a list of Releases.
+
+    Non-dict and non-playable items are skipped. Used directly for the
+    ``recently_played`` feed.
+    """
+    out: List[Release] = []
+    for entry in items or []:
+        rel = item_to_release(entry)
+        if rel is not None:
+            out.append(rel)
+    return out
+
+
+def search_to_releases(res: Dict[str, Any]) -> List[Release]:
+    """Flatten a Music Assistant ``music/search`` response to a list of Releases.
+
+    The response is a dict of buckets (``tracks``, ``albums``, ``artists``,
+    ``playlists``, ``radio``, ``podcasts``, ``audiobooks``); each bucket is a
+    list of media-item dicts. This is bucket-agnostic — every list-valued bucket
+    is flattened — so new bucket keys are handled without code changes.
+    """
+    out: List[Release] = []
+    for bucket in (res or {}).values():
+        if isinstance(bucket, list):
+            out.extend(items_to_releases(bucket))
+    return out
+
+
+# Recently-played feed shares the media-item shape, so it reuses the flat mapper.
+recently_played_to_releases = items_to_releases

py_music_assistant-0.0.1/py_music_assistant/version.py

@@ -0,0 +1,10 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK
+
+__version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}"
+if VERSION_ALPHA:
+    __version__ += f"a{VERSION_ALPHA}"

py_music_assistant-0.0.1/py_music_assistant.egg-info/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: py-music-assistant
+Version: 0.0.1
+Summary: Python HTTP client and mediavocab bridge for a Music Assistant server
+Author-email: JarbasAI <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/py-music-assistant
+Project-URL: Source, https://github.com/TigreGotico/py-music-assistant
+Keywords: music-assistant,mediavocab,ovos,OpenVoiceOS,OCP,media
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: ovos-utils>=0.0.38
+Requires-Dist: mediavocab>=1.0.0
+Requires-Dist: music-assistant-models>=1.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# py-music-assistant
+
+Python HTTP client and [mediavocab](https://github.com/TigreGotico/mediavocab)
+bridge for a [Music Assistant](https://www.music-assistant.io/) server.
+
+It is the single transport + conversion layer shared by the OVOS Music Assistant
+integrations:
+
+- **[ovos-media-plugin-mass](https://github.com/OpenVoiceOS/ovos-media-plugin-mass)** — playback backend (`opm.media.audio`)
+- **[ovos-media-provider-mass](https://github.com/OpenVoiceOS/ovos-media-provider-mass)** — catalog/search provider (`opm.media.provider`)
+- **[ovos-skill-music-assistant](https://github.com/OpenVoiceOS/ovos-skill-music-assistant)** — legacy OCP search skill
+
+## Install
+
+```bash
+pip install py-music-assistant
+```
+
+## Usage
+
+```python
+from py_music_assistant import SimpleHTTPMusicAssistantClient, search_to_releases
+
+api = SimpleHTTPMusicAssistantClient("http://192.168.1.100:8095")
+
+# raw search (dict of buckets: tracks/albums/artists/radio/podcasts/audiobooks)
+res = api.search_media("viagra boys", limit=10)
+
+# mapped to typed mediavocab.Release objects (unranked; score them yourself)
+releases = search_to_releases(res)
+for r in releases:
+    print(r.work.title, r.work.media_type, r.uri)   # e.g. "Worms" MUSIC library://track/9903
+```
+
+The client talks to the server's synchronous JSON `/api` endpoint (no WebSocket
+lifecycle). Item `uri`s are `library://<type>/<id>` identifiers that the
+`ovos-media-plugin-mass` backend resolves and plays.
+
+## Docs
+
+- [docs/index.md](docs/index.md) — overview
+- [docs/client-api.md](docs/client-api.md) — `SimpleHTTPMusicAssistantClient` reference
+- [docs/mediavocab-bridge.md](docs/mediavocab-bridge.md) — dict → `Release` mapping
+
+## Tests
+
+```bash
+pip install -e .[test]
+pytest test/                                   # network-free (mocked + fixtures)
+MASS_SERVER_URL=http://<host>:8095 pytest test/live/   # opt-in, against a real server
+```
+
+## License
+
+Apache-2.0

py_music_assistant-0.0.1/py_music_assistant.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+py_music_assistant/__init__.py
+py_music_assistant/client.py
+py_music_assistant/converters.py
+py_music_assistant/version.py
+py_music_assistant.egg-info/PKG-INFO
+py_music_assistant.egg-info/SOURCES.txt
+py_music_assistant.egg-info/dependency_links.txt
+py_music_assistant.egg-info/requires.txt
+py_music_assistant.egg-info/top_level.txt
+test/test_client.py
+test/test_converters.py

py_music_assistant-0.0.1/py_music_assistant.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_music_assistant-0.0.1/py_music_assistant.egg-info/requires.txt

@@ -0,0 +1,8 @@
+requests
+ovos-utils>=0.0.38
+mediavocab>=1.0.0
+music-assistant-models>=1.0.0
+
+[test]
+pytest
+pytest-cov

py_music_assistant-0.0.1/py_music_assistant.egg-info/top_level.txt

@@ -0,0 +1 @@
+py_music_assistant

py_music_assistant-0.0.1/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-music-assistant"
+dynamic = ["version"]
+description = "Python HTTP client and mediavocab bridge for a Music Assistant server"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+authors = [{ name = "JarbasAI", email = "jarbasai@mailfence.com" }]
+requires-python = ">=3.10"
+keywords = ["music-assistant", "mediavocab", "ovos", "OpenVoiceOS", "OCP", "media"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "requests",
+    "ovos-utils>=0.0.38",
+    "mediavocab>=1.0.0",
+    "music-assistant-models>=1.0.0",
+]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-cov"]
+
+[project.urls]
+Homepage = "https://github.com/TigreGotico/py-music-assistant"
+Source = "https://github.com/TigreGotico/py-music-assistant"
+
+[tool.setuptools]
+packages = ["py_music_assistant"]
+
+[tool.setuptools.dynamic]
+version = { attr = "py_music_assistant.version.__version__" }

py_music_assistant-0.0.1/setup.cfg

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

py_music_assistant-0.0.1/test/test_client.py

@@ -0,0 +1,67 @@
+"""Tests for SimpleHTTPMusicAssistantClient (network-free, mocked session)."""
+from unittest.mock import MagicMock
+
+import pytest
+
+from music_assistant_models.errors import MusicAssistantError
+
+from py_music_assistant import SimpleHTTPMusicAssistantClient
+
+
+def _client(json_return=None, status=200):
+    session = MagicMock()
+    resp = MagicMock()
+    resp.status_code = status
+    resp.json.return_value = json_return if json_return is not None else {}
+    resp.text = "error body"
+    session.post.return_value = resp
+    return SimpleHTTPMusicAssistantClient("http://mass.local:8095/", session=session), session
+
+
+def test_url_normalisation():
+    client, _ = _client()
+    assert client.server_url == "http://mass.local:8095"
+    assert client.api_url == "http://mass.local:8095/api"
+
+
+def test_send_command_posts_payload_and_returns_json():
+    client, session = _client(json_return={"ok": True})
+    out = client.send_command("music/search", search_query="worms", limit=5)
+
+    assert out == {"ok": True}
+    session.post.assert_called_once()
+    args, kwargs = session.post.call_args
+    assert args[0] == "http://mass.local:8095/api"
+    payload = kwargs["json"]
+    assert payload["command"] == "music/search"
+    assert payload["args"] == {"search_query": "worms", "limit": 5}
+    assert "message_id" in payload
+
+
+def test_send_command_raises_on_non_200():
+    client, _ = _client(status=500)
+    with pytest.raises(MusicAssistantError):
+        client.send_command("players/all")
+
+
+def test_search_media_builds_args():
+    client, session = _client(json_return={"tracks": []})
+    client.search_media("worms", limit=7)
+    payload = session.post.call_args.kwargs["json"]
+    assert payload["command"] == "music/search"
+    assert payload["args"]["search_query"] == "worms"
+    assert payload["args"]["limit"] == 7
+
+
+def test_recently_played_command():
+    client, session = _client(json_return=[])
+    client.recently_played()
+    assert session.post.call_args.kwargs["json"]["command"] == "music/recently_played_items"
+
+
+def test_track_info_passes_uri():
+    client, session = _client(json_return={})
+    client.track_info("library://track/9903")
+    payload = session.post.call_args.kwargs["json"]
+    assert payload["command"] == "music/item_by_uri"
+    assert payload["args"] == {"uri": "library://track/9903"}

py_music_assistant-0.0.1/test/test_converters.py

@@ -0,0 +1,146 @@
+"""Tests for the Music Assistant -> mediavocab converters (network-free)."""
+import json
+from os.path import dirname, join
+
+from mediavocab import MediaType, Release, Work
+
+from py_music_assistant.converters import (
+    PLATFORM,
+    item_to_release,
+    items_to_releases,
+    recently_played_to_releases,
+    search_to_releases,
+)
+
+FIXTURES = join(dirname(__file__), "fixtures")
+
+
+def _search_fixture():
+    with open(join(FIXTURES, "search_worms.json")) as f:
+        return json.load(f)
+
+
+TRACK = {
+    "media_type": "track",
+    "name": "Worms",
+    "uri": "library://track/9903",
+    "is_playable": True,
+    "favorite": True,
+    "duration": 208,
+    "artists": [{"name": "Viagra Boys"}],
+    "album": {"name": "Street Worms"},
+    "image": {"path": "https://art.example/worms.jpg", "remotely_accessible": True},
+    "external_ids": {"musicbrainz": "mbid-worms-123"},
+}
+
+
+def test_item_to_release_builds_valid_release():
+    rel = item_to_release(TRACK)
+    assert isinstance(rel, Release)
+    assert isinstance(rel.work, Work)
+    assert rel.work.title == "Worms"
+    assert rel.work.media_type == MediaType.MUSIC
+    assert rel.uri == "library://track/9903"
+    assert rel.image == "https://art.example/worms.jpg"
+    assert rel.platform == PLATFORM
+    assert rel.match_confidence == 0.0
+    assert rel.work.runtime == 208.0
+    assert rel.work.extra["artist"] == "Viagra Boys"
+    assert rel.work.extra["album"] == "Street Worms"
+    assert rel.work.extra["favorite"] is True
+    assert rel.external_ids["musicbrainz"] == "mbid-worms-123"
+
+
+def test_media_type_mapping():
+    def mt(kind, uri="library://x/1"):
+        return item_to_release(
+            {"media_type": kind, "name": "x", "uri": uri, "is_playable": True}
+        ).work.media_type
+
+    assert mt("track") == MediaType.MUSIC
+    assert mt("album") == MediaType.MUSIC
+    assert mt("artist") == MediaType.MUSIC
+    assert mt("playlist") == MediaType.PLAYLIST
+    assert mt("radio") == MediaType.RADIO
+    assert mt("podcast") == MediaType.PODCAST
+    assert mt("audiobook") == MediaType.AUDIOBOOK
+    assert mt("something-new") == MediaType.MUSIC  # unknown -> music fallback
+
+
+def test_item_to_release_skips_unplayable():
+    assert item_to_release({**TRACK, "is_playable": False}) is None
+
+
+def test_item_to_release_skips_missing_name_or_uri():
+    assert item_to_release({"name": "", "uri": "library://x/1", "is_playable": True}) is None
+    assert item_to_release({"name": "x", "uri": "", "is_playable": True}) is None
+    assert item_to_release("not a dict") is None
+
+
+def test_item_to_release_none_guards_missing_artists_and_album():
+    """Items with no artists/album must not raise (the legacy load_track crash)."""
+    rel = item_to_release(
+        {"media_type": "track", "name": "bare", "uri": "library://track/1", "is_playable": True,
+         "artists": None, "album": None}
+    )
+    assert isinstance(rel, Release)
+    assert "artist" not in rel.work.extra
+    assert "album" not in rel.work.extra
+
+
+def test_image_falls_back_to_metadata_images():
+    rel = item_to_release(
+        {"media_type": "track", "name": "x", "uri": "library://track/2", "is_playable": True,
+         "metadata": {"images": [{"path": "https://m/i.jpg", "remotely_accessible": True}]}}
+    )
+    assert rel.image == "https://m/i.jpg"
+
+
+def test_image_skipped_when_not_remotely_accessible():
+    rel = item_to_release(
+        {"media_type": "track", "name": "x", "uri": "library://track/3", "is_playable": True,
+         "image": {"path": "/local/x.jpg", "remotely_accessible": False}}
+    )
+    assert rel.image == ""
+
+
+def test_artist_identity_uses_own_name():
+    rel = item_to_release(
+        {"media_type": "artist", "name": "Viagra Boys", "uri": "library://artist/77",
+         "is_playable": True}
+    )
+    assert rel.work.extra["artist"] == "Viagra Boys"
+
+
+def test_search_to_releases_flattens_all_buckets():
+    res = _search_fixture()
+    releases = search_to_releases(res)
+    titles = [r.work.title for r in releases]
+    # the unplayable artist and the local-only-art track are still playable-by-flag;
+    # only the non-playable artist is dropped
+    assert "Worms" in titles
+    assert "Street Worms" in titles
+    assert "Viagra Boys" in titles
+    assert "Worm Radio" in titles
+    assert "The Worm Cast" in titles
+    assert "How to Train Your Worm" in titles
+    assert "Not Playable Artist" not in titles
+    assert all(isinstance(r, Release) for r in releases)
+    # media types preserved across buckets
+    by_title = {r.work.title: r.work.media_type for r in releases}
+    assert by_title["Worm Radio"] == MediaType.RADIO
+    assert by_title["The Worm Cast"] == MediaType.PODCAST
+    assert by_title["How to Train Your Worm"] == MediaType.AUDIOBOOK
+
+
+def test_search_to_releases_handles_empty_and_garbage():
+    assert search_to_releases({}) == []
+    assert search_to_releases(None) == []
+    assert search_to_releases({"tracks": "notalist", "albums": None}) == []
+
+
+def test_recently_played_is_items_mapper():
+    assert recently_played_to_releases is items_to_releases
+    rels = recently_played_to_releases([TRACK, {"is_playable": False}])
+    assert len(rels) == 1
+    assert rels[0].work.title == "Worms"