Metadata-Version: 1.1
Name: qnapstats
Version: 0.2.2
Summary: Python API for obtaining QNAP NAS system stats
Home-page: https://github.com/colinodell/python-qnapstats
Author: Colin O'Dell
Author-email: colinodell@gmail.com
License: MIT
Description: ================
        python-qnapstats
        ================
        
        .. image:: https://img.shields.io/travis/colinodell/python-qnapstats/master.svg?style=flat-square
           :target: https://travis-ci.org/colinodell/python-qnapstats
           :alt: Build Status
        
        Library from obtaining system information from QNAP NAS devices.
        
        Installation
        ============
        
        This library requires `xmltodict`, so make sure you have that installed:
        
        .. code-block:: bash
        
            pip3 install xmltodict>=0.10.0
        
        Then install this Python module:
        
        .. code-block:: bash
        
            pip3 install qnapstats
        
        Usage Example
        =============
        
        .. code-block:: python
        
            #!/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())
        
        Device Support
        ==============
        
        This library has been tested against the following devices and firmwares:
        
        +--------+-----------------------+ 
        | Model  | QTS Firmware Versions |
        +========+=======================+ 
        | TS-451 | 4.2.2, 4.2.3          |
        +--------+-----------------------+ 
        | TS-639 | 4.2.3                 | 
        +--------+-----------------------+ 
        
        Other devices using these firmwares should probably work fine.
        If you encounter any compatibility issues, please let us know (or better yet, contribute a patch!)
        
Keywords: qnap
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Monitoring
