pyblu 2.0.2__tar.gz → 2.0.3__tar.gz

pyblu-2.0.3/.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+
+	"postCreateCommand": "bash .devcontainer/setup",
+
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"github.copilot"
+			]
+		}
+	}
+}

pyblu-2.0.3/.devcontainer/setup

@@ -0,0 +1,4 @@
+#!/bin/bash
+curl -sSL https://install.python-poetry.org | python3
+poetry config virtualenvs.in-project true
+poetry install

pyblu-2.0.3/.github/dependabot.yml

@@ -0,0 +1,23 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: monthly
+ - package-ecosystem: "pip"
+   directory: "/"
+   schedule:
+     interval: monthly
+   groups:
+     all:
+       patterns:
+         - "*"
+       update-types:
+         - patch
+         - minor

pyblu-2.0.3/.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Publish docs
+
+on:
+  push:
+    branches:
+      - '*'
+    tags:
+      - 'v*'
+    paths:
+      - src/**
+      - docs/**
+      - pyproject.toml
+      - poetry.lock
+      - .github/workflows/docs.yml
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync
+      - name: Sphinx build
+        run: uv run sphinx-build -b html docs _site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pyblu-2.0.3/.github/workflows/test.yml

@@ -0,0 +1,65 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - '*'
+    paths:
+      - src/**
+      - tests/**
+      - pyproject.toml
+      - .github/workflows/test.yml
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync
+      - name: Run pylint
+        run: uv run pylint src tests
+      - name: Run black
+        run: uv run black --check src tests
+
+  typecheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync
+      - name: Run mypy
+        run: uv run mypy src
+
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync
+      - name: Run pytest
+        run: uv run pytest

pyblu-2.0.3/.gitignore

@@ -0,0 +1,169 @@
+# uv
+uv.lock
+
+# sphinx documentation
+/_site/
+
+# JetBrains
+.idea/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pyblu-2.0.3/.run/Tests.run.xml

@@ -0,0 +1,20 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Tests" type="tests" factoryName="py.test">
+    <module name="pyblu" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="_new_keywords" value="&quot;&quot;" />
+    <option name="_new_parameters" value="&quot;&quot;" />
+    <option name="_new_additionalArguments" value="&quot;&quot;" />
+    <option name="_new_target" value="&quot;tests&quot;" />
+    <option name="_new_targetType" value="&quot;PYTHON&quot;" />
+    <method v="2" />
+  </configuration>
+</component>

pyblu-2.0.3/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Tests",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "${workspaceFolder}/tests"
+            ],
+        }
+    ]
+}

{pyblu-2.0.2 → pyblu-2.0.3}/PKG-INFO

@@ -1,19 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyblu
-Version: 2.0.2
-Summary: 
-License: MIT
-Author: Louis Christ
-Author-email: mail@louischrist.de
-Requires-Python: >=3.11,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiohttp (>=3.11.11)
-Requires-Dist: lxml (>=5.0.0)
-Project-URL: Repository, https://github.com/LouisChrist/pyblu
+Version: 2.0.3
+Project-URL: repository, https://github.com/LouisChrist/pyblu
+Author-email: Louis Christ <mail@louischrist.de>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.11.11
+Requires-Dist: lxml>=5.0.0
 Description-Content-Type: text/markdown
 
 # pyblu
@@ -47,4 +40,3 @@ pip install pyblu
 ```
 
 
-

pyblu-2.0.3/docs/api.rst

@@ -0,0 +1,45 @@
+API Reference
+=============
+
+Main Classes
+------------
+
+.. autoclass:: pyblu.Player
+   :members:
+   :special-members: __init__
+
+Data Classes
+------------
+
+.. autoclass:: pyblu.Status
+   :members:
+
+.. autoclass:: pyblu.Volume
+   :members:
+
+.. autoclass:: pyblu.SyncStatus
+   :members:
+
+.. autoclass:: pyblu.PairedPlayer
+   :members:
+
+.. autoclass:: pyblu.Preset
+   :members:
+
+.. autoclass:: pyblu.PlayQueue
+   :members:
+
+.. autoclass:: pyblu.Input
+   :members:
+
+Exceptions
+----------
+
+.. autoclass:: pyblu.errors.PlayerError
+   :members:
+
+.. autoclass:: pyblu.errors.PlayerUnreachableError
+   :members:
+
+.. autoclass:: pyblu.errors.PlayerUnexpectedResponseError
+   :members:

pyblu-2.0.3/docs/conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'pyblu'
+copyright = '2024, Louis Christ'
+author = 'Louis Christ'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

pyblu-2.0.3/docs/index.rst

@@ -0,0 +1,22 @@
+pyblu
+============
+
+This is an Python library for interfacing with BluOS player. It uses the
+`BluOS API <https://bluesound-deutschland.de/wp-content/uploads/2022/01/Custom-Integration-API-v1.0_March-2021.pdf>`_
+to control and query the status of BluOS players.
+
+Basic usage example:
+
+.. code-block:: python
+
+   from pyblu import Player
+
+   async def main():
+      async with Player("<host>") as player:
+         status = await player.status()
+         print(status)
+
+.. toctree::
+   :maxdepth: 2
+
+   api

pyblu-2.0.3/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyblu"
+version = "2.0.3"
+description = ""
+license = "MIT"
+authors = [{ name = "Louis Christ", email = "mail@louischrist.de" }]
+readme = "README.md"
+dependencies = [
+    "aiohttp >= 3.11.11",
+    "lxml >= 5.0.0"]
+
+[project.urls]
+repository = "https://github.com/LouisChrist/pyblu"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyblu"]
+
+[tool.uv]
+dev-dependencies = [
+    "pylint >= 3.2.6",
+    "black >= 24.8.0",
+    "pytest >= 8.3.2",
+    "aioresponses >= 0.7.6",
+    "pytest-asyncio >= 0.24.0",
+    "sphinx >= 8.0.2",
+    "invoke >= 2.2.0",
+    "semver >= 3.0.2",
+    "mypy >= 1.11.2",
+    "pygithub >= 2.4.0",
+    "types-lxml >= 2024.8.7"]
+
+[tool.pylint."messages control"]
+disable = [
+    "missing-function-docstring",
+    "missing-module-docstring",
+    "missing-class-docstring",
+    "too-many-instance-attributes",
+    "too-many-public-methods",
+    "duplicate-code",
+]
+
+[tool.pylint.format]
+max-line-length = 160
+
+[tool.black]
+line-length = 160
+
+[tool.pytest.ini_options]
+pythonpath = "src"
+asyncio_mode = "auto"

pyblu-2.0.3/tasks.py

@@ -0,0 +1,120 @@
+import re
+import os
+
+from invoke import task, Context
+from semver import Version
+import github
+
+
+def _commits_with_version_change(ctx: Context):
+    commits = ctx.run("git log --pretty=format:'%h'", hide=True).stdout.split("\n")
+    for commit in commits[:-1]:
+        diff = ctx.run(f"git diff {commit}~ {commit} pyproject.toml", hide=True).stdout.split("\n")
+        version_lines = [line for line in diff if line.startswith("+version = ")]
+        if not version_lines:
+            continue
+
+        yield commit, version_lines[0].split(" = ")[1].strip('"')
+
+
+def _get_tagged_versions(ctx: Context):
+    tags = ctx.run("git tag", hide=True).stdout.split("\n")
+    return [tag[1:] for tag in tags if re.match(r"v\d+\.\d+\.\d+", tag)]
+
+
+@task
+def add_missing_tags(ctx: Context):
+    tagged_versions = _get_tagged_versions(ctx)
+    missing_commits_with_versions = [x for x in _commits_with_version_change(ctx) if x[1] not in tagged_versions]
+
+    if not missing_commits_with_versions:
+        print("No new versions to tag")
+        return
+
+    for commit, version in missing_commits_with_versions:
+        print(f"Tagging {commit} as {version}")
+        ctx.run(f"git tag -m v{version} v{version} {commit}", hide=True)
+
+
+@task
+def release(ctx: Context):
+    githubToken = os.getenv("GITHUB_TOKEN_PYBLU")
+    if githubToken is None:
+        print("GITHUB_TOKEN_PYBLU environment variable is required")
+        exit(1)
+    githubAuth = github.Auth.Token(githubToken)
+    gh = github.Github(auth=githubAuth)
+    try:
+        githubRepo = gh.get_repo("LouisChrist/pyblu")
+    except github.GithubException:
+        print("No access to LouisChrist/pyblue")
+        exit(1)
+
+    current_branch = ctx.run("git branch --show-current", hide=True).stdout.strip()
+    if current_branch != "main":
+        print("You must be on the main branch to release")
+        exit(1)
+
+    any_changes = ctx.run("git status --porcelain", hide=True).stdout.strip()
+    if any_changes:
+        print("There are uncommited changes")
+        exit(1)
+
+    version = ctx.run("uv version --short", hide=True).stdout.strip()
+    version = Version.parse(version)
+
+    print(f"patch: {version.bump_patch()}")
+    print(f"minor: {version.bump_minor()}")
+    print(f"major: {version.bump_major()}")
+    choice = input("Select version to bump [patch/minor/major]: ")
+    match choice:
+        case "patch":
+            bumped_version = version.bump_patch()
+        case "minor":
+            bumped_version = version.bump_minor()
+        case "major":
+            bumped_version = version.bump_major()
+        case _:
+            print("Invalid choice")
+            exit(1)
+
+    ctx.run(f"uv version --bump {choice}")
+
+    print(f"Creating commit with tag v{bumped_version}")
+    ctx.run("git add pyproject.toml", hide=True)
+    ctx.run(f"git commit -m 'Release v{bumped_version}'", hide=True)
+    ctx.run(f"git tag -m v{bumped_version} v{bumped_version}", hide=True)
+
+    print("Pushing changes")
+    ctx.run("git push --follow-tags", hide=True)
+
+    print("Creating release")
+    githubRepo.create_git_release(f"v{bumped_version}", f"v{bumped_version}", generate_release_notes=True)
+
+    print("Building and publishing package")
+    ctx.run("uv build")
+    ctx.run("uv publish")
+
+    print(f"Release v{bumped_version} created and published")
+
+
+@task
+def format_and_lint(ctx: Context):
+    ctx.run("black src tests")
+    ctx.run("pylint -f colorized src tests")
+
+
+@task
+def test(ctx: Context):
+    ctx.run("pytest tests --color=yes")
+
+
+@task
+def mypy(ctx: Context):
+    ctx.run("mypy src")
+
+
+@task
+def build_docs(ctx: Context):
+    print("Building docs")
+    ctx.run("sphinx-build -b html docs _site", hide=True)