python-qnapstats
Library from obtaining system information from QNAP NAS devices.
Installation
This library requires xmltodict, so make sure you have that installed:
pip3 install xmltodict>=0.10.0Then install this Python module:
pip3 install qnapstatsUsage Example
#!/usr/bin/env python3
from qnapstats import QNAPStats
from pprint import pprint
qnap = QNAPStats('192.168.1.3', 8080, 'admin', 'correcthorsebatterystaple')
pprint(qnap.get_system_stats())
pprint(qnap.get_system_health())
pprint(qnap.get_smart_disk_health())
pprint(qnap.get_volumes())
pprint(qnap.get_bandwidth())Note: The user you connect with must be in the admin group. It doesn’t necessarily need to be THE “administrator” account, but you do need to use some account in the administrators group.
Device Support
This library has been tested against the following devices and firmwares:
Model |
QTS Firmware Versions |
Notes |
|---|---|---|
D4 Pro |
4.5.1 |
User-reported: no automated tests |
TS-110 |
4.2.4 |
|
TS-210 |
4.2.6 |
This device does not report CPU temps |
TS-219P II |
4.3.3 |
User-reported: no automated tests |
TS-251B |
4.4.3 |
|
TS-251+ |
4.5.1 |
No information on dnsInfo |
TS-253 Pro |
4.5.2 |
|
TS-253D |
4.5.3 |
|
TS-332 |
5.0.0 |
|
TS-269L |
4.3.3 |
User-reported: no automated tests |
TS-410 |
4.2.3 |
This device does not report CPU temps |
TS-412 |
4.3.3 |
This device does not report CPU temps |
TS-431P |
4.3.4 |
|
TS-451 |
4.2.2 - 4.2.4 |
|
TS-453A |
4.3.4 |
|
TS-453Be |
4.2.3 |
|
TS-639 |
4.2.3 |
|
TS-659 |
4.2.6 |
May report None for some disk temps |
TS-853 Pro |
4.5.4 |
|
TS-869 Pro |
4.3.4 |
|
TS-1677XU-RP |
4.5.2 |
|
TS-EC1280U |
4.5.2 |
|
TS-X53 |
4.5.4 |
Other QNAP devices using these firmwares should probably work fine, as should the devices listed above on newer firmwares. If you encounter any compatibility issues, please let us know (or better yet, contribute a patch!)
2 maintainers
Metadata
2 maintainers
Release files for qnapstats 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qnapstats-0.5.0.tar.gz | 8.7 kB | With provenance | Details for qnapstats-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qnapstats-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for qnapstats-0.5.0-py3-none-any.whl |
Total release size: 16.0 kB
Release files / qnapstats-0.5.0.tar.gz
| Download URL | qnapstats-0.5.0.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
131f7a5739fd088ae1210594f04d8ba51b2265c9a0aeff5830d77921ae90c141
|
|
BLAKE2b-256 checksum How to use checksums |
b311ae3fd36e71af1d8ae4592aded7e3b0c73552188c0f62c2e31a454a6a5d4f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logRelease files / qnapstats-0.5.0-py3-none-any.whl
| Download URL | qnapstats-0.5.0-py3-none-any.whl |
|---|---|
| Size | 7.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4ebf8c432eb46719bb06fb19785eea93fbaacd68e389dd45458de9382f918bfb
|
|
BLAKE2b-256 checksum How to use checksums |
72262e34b752158f62d4cf0f042f1dc67bd1efc2166b2fd2d3c3360e4ef1acc5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logSecurity for qnapstats 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for qnapstats-0.5.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
