Stan Janssen 619507fbaa Fix failing tests on Python 3.8 | 3 years ago | |
---|---|---|
.github | 3 years ago | |
certificates | 3 years ago | |
docs | 3 years ago | |
openleadr | 3 years ago | |
test | 3 years ago | |
.gitignore | 4 years ago | |
CODE_OF_CONDUCT.md | 4 years ago | |
CONTRIBUTING.md | 4 years ago | |
LICENSE | 4 years ago | |
MANIFEST.in | 3 years ago | |
README.md | 3 years ago | |
VERSION | 3 years ago | |
dev_requirements.txt | 4 years ago | |
logo.png | 4 years ago | |
setup.py | 3 years ago |
OpenLEADR is a Python 3 module that provides a convenient interface to OpenADR systems. It contains an OpenADR Client that you can use to talk to other OpenADR systems, and it contains an OpenADR Server (VTN) with convenient integration possibilities.
It currently implements the OpenADR 2.0b specification.
You can find documentation here: https://openleadr.org/docs.
If you'd like to help make OpenLEADR better, you can do so in the following ways:
We keep track of all bugs and feature requests on Github Issues. Please search the already close issues to see if your question was asked before.
You're also very welcome to leave comments on existing issues with your ideas on how to improve OpenLEADR.
We'd love for you to contribute code to the project. We'll take a look at all pull requests, no matter their state. Please note though, that we will only accept pull requests if they meet at least the following criteria:
git commit -s
), to indicate that your contribution complies with our license and does not violate anybody else's copyright.That said, please don't let the above requirements discourage you from filing a pull requests. If you don't meet all of the above requirements, we'll help you fix the remaining things to get it into shape.
Let it be clear that this code base is still in a development stage, and we don't yet recommend using it for mission critical applications or applications where security is paramount.
That said, we do try to make OpenLEADR as secure as can be to work with. If you find a security vulnerability in OpenLEADR, please let us know at security AT openleadr DOT org. We will get back to you within 72 hours to follow up. We are committed to the following steps:
We recommend the following development setup for working with OpenLEADR (this is on Linux / macOS):
git clone https://github.com/openleadr/openleadr-python
cd openleadr-python
python3 -m venv python_env
./python_env/bin/pip3 install -e .
./python_env/bin/pip3 install -r dev_requirements.txt
To run the test suite, you can use the following command:
./python_env/bin/python3 -m pytest -v test/