sabnzbd-api

Name	sabnzbd-api JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	Complete API wrapper for the usenet downloading tool SABnzbd
upload_time	2025-02-20 19:36:03
maintainer	None
docs_url	None
author	Andrews Jack
requires_python	>=3.6
license	MIT
keywords	sabnzbd client api wrapper
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # sabnzbd-api

`sabnzbd-api` is a lightweight and easy-to-use Python library that simplifies interactions with the SABnzbd API. It provides a convenient way to integrate SABnzbd functionality into your Python applications, allowing you to manage and automate NZB downloads programmatically.

## Features

- Authenticate using your API key.
- Access SABnzbd's API endpoints with minimal setup.
- Includes All Functionalities

This project was inspired by and built upon the work of **anasty17**

## Installation

Install the library using pip:

```bash
pip install sabnzbd-api
```

## Usage

Here's a quick example of how to use the library:

```python
from sabnzbd_api import SabnzbdClient

nzb_file = "file.nzb"

client = SabnzbdClient(host="http://localhost", api_key="your_api_key")

add_nzb = client.add_uri(file=nzb_file)

progress = client.get_downloads(nzo_ids=add_nzb.get("nzo_ids")[0])

print(progress)

client.close()
```

## Requirements

- Python 3.6+

## Credits

This package was inspired by and built upon the work of **anasty17**.



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sabnzbd-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "sabnzbd client api wrapper",
    "author": "Andrews Jack",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a5/ab/a0cf6a4bc977afd60a7f9846c1805cf709db73feef7705ee0c4397924f48/sabnzbd-api-0.1.2.tar.gz",
    "platform": null,
    "description": "# sabnzbd-api\r\n\r\n`sabnzbd-api` is a lightweight and easy-to-use Python library that simplifies interactions with the SABnzbd API. It provides a convenient way to integrate SABnzbd functionality into your Python applications, allowing you to manage and automate NZB downloads programmatically.\r\n\r\n## Features\r\n\r\n- Authenticate using your API key.\r\n- Access SABnzbd's API endpoints with minimal setup.\r\n- Includes All Functionalities\r\n\r\nThis project was inspired by and built upon the work of **anasty17**\r\n\r\n## Installation\r\n\r\nInstall the library using pip:\r\n\r\n```bash\r\npip install sabnzbd-api\r\n```\r\n\r\n## Usage\r\n\r\nHere's a quick example of how to use the library:\r\n\r\n```python\r\nfrom sabnzbd_api import SabnzbdClient\r\n\r\nnzb_file = \"file.nzb\"\r\n\r\nclient = SabnzbdClient(host=\"http://localhost\", api_key=\"your_api_key\")\r\n\r\nadd_nzb = client.add_uri(file=nzb_file)\r\n\r\nprogress = client.get_downloads(nzo_ids=add_nzb.get(\"nzo_ids\")[0])\r\n\r\nprint(progress)\r\n\r\nclient.close()\r\n```\r\n\r\n## Requirements\r\n\r\n- Python 3.6+\r\n\r\n## Credits\r\n\r\nThis package was inspired by and built upon the work of **anasty17**.\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Complete API wrapper for the usenet downloading tool SABnzbd",
    "version": "0.1.2",
    "project_urls": null,
    "split_keywords": [
        "sabnzbd",
        "client",
        "api",
        "wrapper"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1406b9a7135a8fe164fe928265647694c0963a6e6a5439228c915ae866d13586",
                "md5": "7023cfcd9de87081fd0553239fc3c5fb",
                "sha256": "65ab9aecda300e574c5074b0ae4b971f61346d89d9e3f80393dc72c712ac3797"
            },
            "downloads": -1,
            "filename": "sabnzbd_api-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7023cfcd9de87081fd0553239fc3c5fb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8300,
            "upload_time": "2025-02-20T19:35:58",
            "upload_time_iso_8601": "2025-02-20T19:35:58.948409Z",
            "url": "https://files.pythonhosted.org/packages/14/06/b9a7135a8fe164fe928265647694c0963a6e6a5439228c915ae866d13586/sabnzbd_api-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a5aba0cf6a4bc977afd60a7f9846c1805cf709db73feef7705ee0c4397924f48",
                "md5": "6e248b2c6d7dcf8d39f5386b5204fb7a",
                "sha256": "1bb0defcb1aa19333f717a63464fbdc8b8a748a00ca4289be5c7496f045d339f"
            },
            "downloads": -1,
            "filename": "sabnzbd-api-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "6e248b2c6d7dcf8d39f5386b5204fb7a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 7529,
            "upload_time": "2025-02-20T19:36:03",
            "upload_time_iso_8601": "2025-02-20T19:36:03.397651Z",
            "url": "https://files.pythonhosted.org/packages/a5/ab/a0cf6a4bc977afd60a7f9846c1805cf709db73feef7705ee0c4397924f48/sabnzbd-api-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-20 19:36:03",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "sabnzbd-api"
}