aioaudiobookshelf-plus 0.2.0__tar.gz

aioaudiobookshelf_plus-0.2.0/.gitignore

@@ -0,0 +1,31 @@
+# Byte-compiled / optimized files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+wheels/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test / type-check / coverage caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store

aioaudiobookshelf_plus-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

aioaudiobookshelf_plus-0.2.0/NOTICE

@@ -0,0 +1,18 @@
+aioaudiobookshelf-plus
+Copyright 2026 Brian Freeman
+
+This product includes software derived from the aioaudiobookshelf project by the
+Music Assistant team (https://github.com/music-assistant/aioaudiobookshelf),
+licensed under the Apache License, Version 2.0.
+
+The model layer in src/aioaudiobookshelf_plus/schema/ is derived from that
+project's schema definitions. Modifications include renaming the package to
+aioaudiobookshelf_plus and adjusting internal imports accordingly. The original
+Apache-2.0 license terms continue to apply to that derived code and are included
+in the LICENSE file.
+
+The client layer of aioaudiobookshelf-plus is original work by Brian Freeman.
+
+"Audiobookshelf" and the advplyr/audiobookshelf server
+(https://github.com/advplyr/audiobookshelf) are the work of their respective
+authors; this library is an independent client and is not affiliated with them.

aioaudiobookshelf_plus-0.2.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: aioaudiobookshelf-plus
+Version: 0.2.0
+Summary: Fully typed async client for the Audiobookshelf API.
+Author-email: Brian Freeman <brian@freemanator.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: aiohttp
+Requires-Dist: mashumaro
+Requires-Dist: python-socketio>=5.12
+Provides-Extra: test
+Requires-Dist: coverage==7.6.1; extra == 'test'
+Requires-Dist: mypy==1.13.0; extra == 'test'
+Requires-Dist: pytest-aiohttp==1.0.5; extra == 'test'
+Requires-Dist: pytest-asyncio==0.24.0; extra == 'test'
+Requires-Dist: pytest-cov==5.0.0; extra == 'test'
+Requires-Dist: pytest==8.3.4; extra == 'test'
+Requires-Dist: ruff==0.9.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# aioaudiobookshelf-plus
+
+A fully typed async client for the [Audiobookshelf](https://github.com/advplyr/audiobookshelf)
+API.
+
+The library exposes strongly typed data models (backed by
+[mashumaro](https://github.com/Fatal1ty/mashumaro)) and an async client built on
+`aiohttp` and `python-socketio`. Every public surface is type annotated and the
+package ships a `py.typed` marker, so downstream consumers get full inline types
+and `mypy --strict` support.
+
+## Status
+
+Phase 1: the typed model layer under `aioaudiobookshelf_plus.schema` is in place.
+The async client layer is under active development and lands in a later phase.
+
+## Installation
+
+```bash
+pip install aioaudiobookshelf-plus
+```
+
+## Usage
+
+```python
+from aioaudiobookshelf_plus.schema.media_progress import MediaProgress
+
+progress = MediaProgress.from_json(raw_json)
+```
+
+## Attribution and licensing
+
+This project is licensed under the Apache License, Version 2.0. See
+[`LICENSE`](LICENSE).
+
+The model layer in `src/aioaudiobookshelf_plus/schema/` is **derived from**
+[`music-assistant/aioaudiobookshelf`](https://github.com/music-assistant/aioaudiobookshelf),
+which is also licensed under Apache-2.0. See [`NOTICE`](NOTICE) for the full
+attribution. The client layer is original work.

aioaudiobookshelf_plus-0.2.0/README.md

@@ -0,0 +1,39 @@
+# aioaudiobookshelf-plus
+
+A fully typed async client for the [Audiobookshelf](https://github.com/advplyr/audiobookshelf)
+API.
+
+The library exposes strongly typed data models (backed by
+[mashumaro](https://github.com/Fatal1ty/mashumaro)) and an async client built on
+`aiohttp` and `python-socketio`. Every public surface is type annotated and the
+package ships a `py.typed` marker, so downstream consumers get full inline types
+and `mypy --strict` support.
+
+## Status
+
+Phase 1: the typed model layer under `aioaudiobookshelf_plus.schema` is in place.
+The async client layer is under active development and lands in a later phase.
+
+## Installation
+
+```bash
+pip install aioaudiobookshelf-plus
+```
+
+## Usage
+
+```python
+from aioaudiobookshelf_plus.schema.media_progress import MediaProgress
+
+progress = MediaProgress.from_json(raw_json)
+```
+
+## Attribution and licensing
+
+This project is licensed under the Apache License, Version 2.0. See
+[`LICENSE`](LICENSE).
+
+The model layer in `src/aioaudiobookshelf_plus/schema/` is **derived from**
+[`music-assistant/aioaudiobookshelf`](https://github.com/music-assistant/aioaudiobookshelf),
+which is also licensed under Apache-2.0. See [`NOTICE`](NOTICE) for the full
+attribution. The client layer is original work.

aioaudiobookshelf_plus-0.2.0/pyproject.toml

@@ -0,0 +1,141 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[project]
+name = "aioaudiobookshelf-plus"
+version = "0.2.0"
+description = "Fully typed async client for the Audiobookshelf API."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [
+  {name = "Brian Freeman", email = "brian@freemanator.com"},
+]
+classifiers = [
+  "Environment :: Console",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+dependencies = [
+  "aiohttp",
+  "mashumaro",
+  "python-socketio>=5.12",
+]
+
+[project.optional-dependencies]
+test = [
+  "coverage==7.6.1",
+  "mypy==1.13.0",
+  "pytest==8.3.4",
+  "pytest-aiohttp==1.0.5",
+  "pytest-asyncio==0.24.0",
+  "pytest-cov==5.0.0",
+  "ruff==0.9.2",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aioaudiobookshelf_plus"]
+
+[tool.hatch.build]
+# Ship the typing marker so downstream consumers get the inline types.
+include = [
+  "src/aioaudiobookshelf_plus/**/*.py",
+  "src/aioaudiobookshelf_plus/py.typed",
+]
+
+[tool.ruff]
+fix = true
+show-fixes = true
+line-length = 100
+target-version = "py312"
+src = ["src", "tests"]
+
+[tool.ruff.format]
+# Force Linux/MacOS line endings.
+line-ending = "lf"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+  "ANN002", # Not useful for **kwargs
+  "ANN003", # Not useful for **kwargs
+  "ANN401", # Allow dynamically typed expressions where needed
+  "COM812", # Conflicts with the Ruff formatter
+  "D203", # Conflicts with other rules
+  "D213", # Conflicts with other rules
+  "D417", # False positives in some occasions
+  "EM101", # Allow string literals in exceptions
+  "EM102", # Allow f-strings in exceptions
+  "ERA001", # Allow commented out code
+  "FIX002", # Allow TODO comments
+  "PLR2004", # Allow magic values in comparisons
+  "S101", # assert is used in tests and to satisfy the type checker
+  "TC001", # Not useful here
+  "TC003", # Not useful here
+  "TD002", # Do not require TODO authors
+  "TD003", # Do not require TODO issue links
+  "TRY003", # Allow long messages outside the exception class
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25
+
+[tool.ruff.lint.pylint]
+max-args = 10
+max-branches = 25
+max-returns = 15
+max-statements = 50
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+  "D100", # Missing docstring in public module
+  "D101", # Missing docstring in test helper classes
+  "D102", # Missing docstring in test helper methods
+  "D103", # Missing docstring in public function
+  "D105", # Missing docstring in magic method
+  "D107", # Missing docstring in test helper __init__
+  "D401", # Test docstrings need not be imperative
+  "S101", # asserts are expected in tests
+  "S105", # test fixtures use dummy tokens
+  "S106", # test fixtures use dummy tokens/passwords as kwargs
+  "S107", # test fixtures use dummy tokens as defaults
+  "SLF001", # tests deliberately exercise private request helpers
+  "TC002", # tests import types at runtime for casts
+  "PLR2004", # magic values are fine in test assertions
+]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src/aioaudiobookshelf_plus"]
+# Suppress errors about unsatisfied third-party imports (mashumaro, socketio).
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = "--cov=aioaudiobookshelf_plus --cov-report=term-missing"
+testpaths = ["tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["aioaudiobookshelf_plus"]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 100
+exclude_also = [
+  # Type-checking-only imports never run at runtime.
+  "if TYPE_CHECKING:",
+]