Metadata-Version: 2.1
Name: zipatopy
Version: 0.2
Summary: The Python library to interact with Zipato smarthome controllers
Home-page: https://github.com/goooroooX/ZipatoPy
Author: Dmitry Nikolaenya
License: Apache 2.0
Description: # ZipatoPy: Zipato Python API
        
        The Python library to interact with Zipato smarthome controllers.
        
        Inspired by [ggruner](https://github.com/ggruner/Zipatoapi).
        Tested with Zipato Zipatile.
        
        Main features:
        * list devices, endpoints, attributes and attribute values
        * manipulate virtual endpoints (create/get/set/delete)
        * synchronization of Zipato controller
        * local and cloud mode
        * no external dependencies (build-in Python libs only)
        * logging and verbose debug
        
        TODO:
        * integrate as [Home Assistant](https://www.home-assistant.io/) sensor
        
        ## Getting Started
        
        These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
        
        ### Python Version
        
        ```
        Python 2.7
        Python 3.6
        ```
        
        ### Installation
        
        From PyPI repository:
        ```
        pip install --upgrade zipatopy
        ```
        
        From source:
        ```
        git clone https://github.com/goooroooX/ZipatoPy.git
        ```
        
        ### Test run
        
        Start with included [samples](https://github.com/goooroooX/ZipatoPy/tree/master/samples):
        * change USERNAME and PASSWORD to your my.zipato.com account information
        * for test1.py change also DEVICE, ENDPOINT and ATTRIBUTE
        
        ```
        python test1.py
        python test2.py
        ```
        
        API initialization for a cloud mode:
        ```
        from zipatopy import ZipatoPy
        api = ZipatoPy(USERNAME, PASSWORD, verbose=True)
        print(api.get_devices())
        ```
        
        API initialization for a local mode:
        ```
        from zipatopy import ZipatoPy
        api = ZipatoPy(USERNAME, PASSWORD, url='http://X.X.X.X:8080/zipato-web/v2/', verbose=True)
        print(api.get_devices())
        ```
        **NOTE**: local mode is limited comparing to cloud mode, but you will still be able to get attribute values when requesting directly with UUID.
        
        ## Author
        
        * **Dmitry Nikolaenya** - *code base* - [gooorooo.com](https://gooorooo.com)
        
        ## License
        
        This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. 
Keywords: zipato api client
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP
Description-Content-Type: text/markdown
