aiosabnzbd 0.1.0

Description:

aiosabnzbd 0.1.0

aiosabnzbd







Asynchronous Python client for SABnzbd.
About
This package allows you to fetch data from SABnzbd.
Installation
pip install aiosabnzbd

Usage
import asyncio

from aiosabnzbd import Sabnzbd


async def main() -> None:
"""Run the example."""
async with Sabnzbd(api_key="abc123", host="localhost", port=8080) as client:
response = await client.queue()

print(f"Time left for downloads: {response.timeleft}")


if __name__ == "__main__":
asyncio.run(main())

Changelog & Releases
This repository keeps a change log using GitHub's releases
functionality. The format of the log is based on
Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented
based on the following:

MAJOR: Incompatible or major changes.
MINOR: Backwards-compatible new features and enhancements.
PATCH: Backwards-compatible bugfixes and package updates.

Contributing
This is an active open-source project. I am always open to people who want to
use the code or contribute to it.
Thank you for being involved! :heart_eyes:
Setting up development environment
This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.
You need at least:

Python 3.11+
Poetry
NodeJS 20+ (including NPM)

To install all packages, including all development requirements:
npm install
poetry install

As this repository uses the pre-commit framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
poetry run pre-commit run --all-files

To run just the Python tests:
poetry run pytest

Authors & contributors
The content is by Jan-Philipp Benecke.
For a full list of all authors and contributors,
check the contributor's page.
License
MIT License
Copyright (c) 2024 Jan-Philipp Benecke
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.