{"id":15442925,"url":"https://github.com/colinodell/python-qnapstats","last_synced_at":"2025-04-12T16:37:08.635Z","repository":{"id":15966491,"uuid":"79057391","full_name":"colinodell/python-qnapstats","owner":"colinodell","description":"Python API for obtaining QNAP NAS system stats","archived":false,"fork":false,"pushed_at":"2024-06-22T09:03:57.000Z","size":146,"stargazers_count":76,"open_issues_count":1,"forks_count":30,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-03T17:12:29.147Z","etag":null,"topics":["api","hacktoberfest","python","python-3","qnap","wrapper"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/colinodell.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-15T20:25:45.000Z","updated_at":"2025-03-22T17:00:17.000Z","dependencies_parsed_at":"2024-06-18T21:30:59.552Z","dependency_job_id":"4fa1e6b7-a2b3-4cd8-b3b2-a80fa6f2ec2f","html_url":"https://github.com/colinodell/python-qnapstats","commit_stats":{"total_commits":135,"total_committers":16,"mean_commits":8.4375,"dds":"0.33333333333333337","last_synced_commit":"3049494b8124124b3b9f7a08eb27fdb102340ae4"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinodell%2Fpython-qnapstats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinodell%2Fpython-qnapstats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinodell%2Fpython-qnapstats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colinodell%2Fpython-qnapstats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/colinodell","download_url":"https://codeload.github.com/colinodell/python-qnapstats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248597548,"owners_count":21130897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","hacktoberfest","python","python-3","qnap","wrapper"],"created_at":"2024-10-01T19:31:50.412Z","updated_at":"2025-04-12T16:37:08.600Z","avatar_url":"https://github.com/colinodell.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"================\npython-qnapstats\n================\n\n.. image:: https://img.shields.io/github/actions/workflow/status/colinodell/python-qnapstats/test.yml?branch=master\u0026?style=flat-square\n   :target: https://github.com/colinodell/python-qnapstats/actions?query=workflow%3ATest+branch%3Amaster\n   :alt: Build Status\n.. image:: https://img.shields.io/pypi/pyversions/qnapstats.svg?style=flat-square\n   :target: https://pypi.python.org/pypi/qnapstats\n   :alt: Supported Python Versions\n\nLibrary from obtaining system information from QNAP NAS devices running QTS.\n\nInstallation\n============\n\nThis library requires `xmltodict`, so make sure you have that installed:\n\n.. code-block:: bash\n\n    pip3 install xmltodict\u003e=0.10.0\n\nThen install this Python module:\n\n.. code-block:: bash\n\n    pip3 install qnapstats\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    #!/usr/bin/env python3\n    from qnapstats import QNAPStats\n    from pprint import pprint\n    \n    qnap = QNAPStats('192.168.1.3', 8080, 'admin', 'correcthorsebatterystaple')\n    \n    pprint(qnap.get_system_stats())\n    pprint(qnap.get_system_health())\n    pprint(qnap.get_smart_disk_health())\n    pprint(qnap.get_volumes())\n    pprint(qnap.get_bandwidth())\n\n**Note:** The user you connect with must be in the admin group. It doesn't necessarily\nneed to be THE \"administrator\" account, but you do need to use some account in the\nadministrators group.  MFA must also be disabled for that user for this library to work.\n\nDevice Support\n==============\n\nThis library has been tested against the following devices and firmwares:\n\n+--------------+------------------------+---------------------------------------+\n| Model        | QTS* Firmware Versions | Notes                                 |\n+==============+========================+=======================================+\n| D4 Pro       | 4.5.1                  | User-reported: no automated tests     |\n+--------------+------------------------+---------------------------------------+\n| TS-110       | 4.2.4                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-112P      | 4.3.3                  | This device does not report CPU temps |\n+--------------+------------------------+---------------------------------------+\n| TS-210       | 4.2.6                  | This device does not report CPU temps |\n+--------------+------------------------+---------------------------------------+\n| TS-219P II   | 4.3.3                  | User-reported: no automated tests     |\n+--------------+------------------------+---------------------------------------+\n| TS-251B      | 4.4.3                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-228A      | 5.0.1                  | This device does not report CPU temps |\n+--------------+------------------------+---------------------------------------+\n| TS-233       | 5.1.x                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-251+      | 4.5.1                  | No information on dnsInfo             |\n+--------------+------------------------+---------------------------------------+\n| TS-253 Pro   | 4.5.2                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-253D      | 4.5.3                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-332       | 5.0.0                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-364       | 5.0.1                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-269L      | 4.3.3                  | User-reported: no automated tests     |\n+--------------+------------------------+---------------------------------------+\n| TS-410       | 4.2.3                  | This device does not report CPU temps |\n+--------------+------------------------+---------------------------------------+\n| TS-412       | 4.3.3                  | This device does not report CPU temps |\n+--------------+------------------------+---------------------------------------+\n| TS-431P      | 4.3.4                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-451       | 4.2.2 - 4.2.4          |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-453A      | 4.3.4; 5.0.1           |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-453Be     | 4.2.3; 5.0.1           |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-639       | 4.2.3                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-659       | 4.2.6                  | May report `None` for some disk temps |\n+--------------+------------------------+---------------------------------------+\n| TS-853 Pro   | 4.5.4                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-869 Pro   | 4.3.4                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-873A      | 5.0.1.2248             |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-1677XU-RP | 4.5.2                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-EC1280U   | 4.5.2                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-h886      | QuTS h5.0.1.2376       |                                       |\n+--------------+------------------------+---------------------------------------+\n| TS-X53       | 4.5.4                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TVS-672N     | 5.0.1                  |                                       |\n+--------------+------------------------+---------------------------------------+\n| TVS-1282     | 5.0.1                  |                                       |\n+--------------+------------------------+---------------------------------------+\n\n⚠️ *QuTS is not currently supported - see [issue #84](https://github.com/colinodell/python-qnapstats/issues/84)*\n\nOther QNAP devices using these QTS firmwares should probably work fine, as should the devices listed above on newer firmwares.\nIf you encounter any compatibility issues, please let us know (or better yet, contribute a patch!)\n\n\n**Upgrading to QTS 5?** Make sure the account you connect with meets the criteria listed earlier in this README.\nAlso be sure to log into your NAS and complete any agreements, warnings, wizards, etc. that may prevent this\nlibrary from using the QNAP API.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolinodell%2Fpython-qnapstats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcolinodell%2Fpython-qnapstats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolinodell%2Fpython-qnapstats/lists"}