Metadata-Version: 2.1
Name: zepben.evolve
Version: 0.22.0b7
Summary: Python SDK for interacting with the Evolve platform
Home-page: https://github.com/zepben/evolve-sdk-python
Author: Kurt Greaves
Author-email: kurt.greaves@zepben.com
License: MPL 2.0
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: protobuf
Requires-Dist: requests
Requires-Dist: zepben.protobuf (>=0.9.0)
Requires-Dist: python-jose-cryptodome
Requires-Dist: dataclassy
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-asyncio ; extra == 'test'
Requires-Dist: hypothesis (<6) ; extra == 'test'

![Build Status](https://img.shields.io/github/workflow/status/zepben/evolve-sdk-python/Deploy%20snapshot%20to%20Pypi)
[![Coverage](https://coveralls.io/repos/github/zepben/evolve-sdk-python/badge.svg)](https://coveralls.io/github/zepben/evolve-sdk-python)

# Zepben Evolve Python SDK #
The Python Evolve SDK contains everything necessary to communicate with a [Zepben EWB Server](https://github.com/zepben/energy-workbench-server). See the [architecture](docs/architecture.md) documentation for more details.

ote this project is still a work in progress and unstable, and breaking changes may occur prior to 1.0.0. 

# Requirements #

- Python 3.7 or later
- pycryptodome, which requires a C/C++ compiler to be installed.
On Linux, python headers (typically `python-dev`) is also necessary to build pycryptodome.

##### On Windows systems: 

Download and run [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019)

When in the installer, select and install:
- C++ build tools
- Windows 10 SDK
- The latest version of MSVC v142 x64/x86 build tools.

After this you should be able to `pip install zepben.evolve` without issues.

# Installation #

    pip install zepben.evolve


# Building #

    python setup.py bdist_wheel

# Developing ##

This library depends on protobuf and gRPC for messaging. To set up for developing against this library, clone it first:

    git clone https://github.com/zepben/evolve-sdk-python.git

Install as an editable install. It's recommended to install in a [Python virtualenv](https://virtualenv.pypa.io/en/stable/)

    cd evolve-sdk-python
    pip install -e .[test]

Run the tests: 

    python -m pytest



