truenaspy

Name	truenaspy JSON
Version	0.7.7 JSON
	download
home_page	None
Summary	Provides asynchronous authentication and access to Truenas devices
upload_time	2024-12-20 18:26:31
maintainer	None
docs_url	None
author	None
requires_python	>=3.12.0
license	GPL-3
keywords	async truenas scale core
VCS
bugtrack_url
requirements	aiohttp semantic_version mashumaro
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Truenaspy

Fetch data from TrueNas

## Install

Use the PIP package manager

```bash
$ pip install truenaspy
```

Or manually download and install the last version from github

```bash
$ git clone https://github.com/cyr-ius/truenaspy.git
$ python setup.py install
```

## Get started

```python
# Import the truenaspy package.
from truenaspy import TrueNASAPI

TOKEN="012345"
HOST="1.2.3.4:8080"

async def main():
    api = TrueNASAPI(token=TOKEN, host=HOST, use_ssl=False, verify_ssl=False)
    rslt = await api.async_get_system()
    print(rlst)
    await api.async_close()

loop = asyncio.get_event_loop()
loop.run_until_complete(main())
```

Have a look at the [example.py](https://github.com/cyr-ius/truenaspy/blob/master/example.py) for a more complete overview.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "truenaspy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12.0",
    "maintainer_email": null,
    "keywords": "async, truenas, scale, core",
    "author": null,
    "author_email": "Cyr-ius <cyr-ius@ipocus.net>",
    "download_url": "https://files.pythonhosted.org/packages/d7/fc/43ebc1bb29a08d6e82a7e27c995ebee61cd39916308ebc7ffe4845a69786/truenaspy-0.7.7.tar.gz",
    "platform": "any",
    "description": "# Truenaspy\n\nFetch data from TrueNas\n\n## Install\n\nUse the PIP package manager\n\n```bash\n$ pip install truenaspy\n```\n\nOr manually download and install the last version from github\n\n```bash\n$ git clone https://github.com/cyr-ius/truenaspy.git\n$ python setup.py install\n```\n\n## Get started\n\n```python\n# Import the truenaspy package.\nfrom truenaspy import TrueNASAPI\n\nTOKEN=\"012345\"\nHOST=\"1.2.3.4:8080\"\n\nasync def main():\n    api = TrueNASAPI(token=TOKEN, host=HOST, use_ssl=False, verify_ssl=False)\n    rslt = await api.async_get_system()\n    print(rlst)\n    await api.async_close()\n\nloop = asyncio.get_event_loop()\nloop.run_until_complete(main())\n```\n\nHave a look at the [example.py](https://github.com/cyr-ius/truenaspy/blob/master/example.py) for a more complete overview.\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "Provides asynchronous authentication and access to Truenas devices",
    "version": "0.7.7",
    "project_urls": {
        "Homepage": "https://github.com/cyr-ius/truenaspy"
    },
    "split_keywords": [
        "async",
        " truenas",
        " scale",
        " core"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "027a30a3ef453a8530192f048666964d8422ff28d8fe1733cea26e04e567126d",
                "md5": "908f32e216cb916dab9248287124611d",
                "sha256": "e360ed9f2805134bccfb3f3fb9a1b0fb87056dfeb117a7516ab9f09b8f4dadb5"
            },
            "downloads": -1,
            "filename": "truenaspy-0.7.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "908f32e216cb916dab9248287124611d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12.0",
            "size": 25449,
            "upload_time": "2024-12-20T18:26:29",
            "upload_time_iso_8601": "2024-12-20T18:26:29.004775Z",
            "url": "https://files.pythonhosted.org/packages/02/7a/30a3ef453a8530192f048666964d8422ff28d8fe1733cea26e04e567126d/truenaspy-0.7.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d7fc43ebc1bb29a08d6e82a7e27c995ebee61cd39916308ebc7ffe4845a69786",
                "md5": "64b140a6fd32a58196658dcc83ea605f",
                "sha256": "7c7a0f0aeb277ef34ca9adb8988ce8a1faffb3f2ef597c6b1b42167e1c96d397"
            },
            "downloads": -1,
            "filename": "truenaspy-0.7.7.tar.gz",
            "has_sig": false,
            "md5_digest": "64b140a6fd32a58196658dcc83ea605f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12.0",
            "size": 28386,
            "upload_time": "2024-12-20T18:26:31",
            "upload_time_iso_8601": "2024-12-20T18:26:31.021618Z",
            "url": "https://files.pythonhosted.org/packages/d7/fc/43ebc1bb29a08d6e82a7e27c995ebee61cd39916308ebc7ffe4845a69786/truenaspy-0.7.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 18:26:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cyr-ius",
    "github_project": "truenaspy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "aiohttp",
            "specs": [
                [
                    ">=",
                    "3.9.5"
                ]
            ]
        },
        {
            "name": "semantic_version",
            "specs": [
                [
                    ">=",
                    "2.10.0"
                ]
            ]
        },
        {
            "name": "mashumaro",
            "specs": [
                [
                    ">=",
                    "3.13"
                ]
            ]
        }
    ],
    "lcname": "truenaspy"
}