Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 19 committers (5.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.6%) to scientific vocabulary
Keywords
Repository
Python library for OpenADR 2.0b
Basic Info
- Host: GitHub
- Owner: OpenLEADR
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://openleadr.org/docs
- Size: 775 KB
Statistics
- Stars: 147
- Watchers: 14
- Forks: 65
- Open Issues: 40
- Releases: 4
Topics
Metadata Files
README.md
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.
Documentation
You can find documentation here: https://openleadr.org/docs.
Getting started
We have cool 1-minute starting examples for both VEN and VTN. Please check them out and take a look at the rest of the documentation.
Feature Completeness
At the moment, you can do basic Registration, Telemetry Reports and Events over a secured connection using signed messages. This covers many use-cases that allow for demand response to be coordinated. Below is a more extensive list of OpenADR features and their current implementation status in OpenLEADR:
The following is an overview of OpenADR 2.0b features that are implemented in OpenADR:
| Feature | Implemented | Remarks | |------------------------|-------------|--------------------------------------------------| | Transport | | HTTP Pull Method | ✔️ | Most-used method, allows VEN to be behind NAT | | HTTP Push Method | ❌ | | | XMPP Transport | ❌ | | | Message Signing | ✔️ | Official OpenADR Alliance Root Cert not included | | Registration | | Registration procedure | ✔️ | | | Reporting | | Telemetry Reports | ✔️ | | | Status Reports | ❌ | Work is in progress, see #108 | | History Reports | ❌ | | | Events | | Events | ✔️ | | | EiOpt | ❌ | |
Contributing
If you'd like to help make OpenLEADR better, you can do so in the following ways:
File bug report or feature request
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.
File a pull request
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:
- Your code style is flake8 compliant (with a maximum line length of 127 characters)
- You provide tests for your new code and your code, and you amend any previous tests that fail if they are impacted by your code change
- Your pull request refers to an Issue on our issue tracker, so that we and other people can see what problem is being solved.
- You sign off your commits (
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.
Security issues
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:
- Security vulnerabilities with a known fix will be addressed as soon as possible. This means that work on other things will be put on hold until the security issue is fixed.
- If a fix is not readily available, we will publish a warning that describes the vulnerable situation and, if possible, any mitigating steps that users of OpenLEADR can take.
- After any security issue is fixed, we will publish information on it in the Changelog.
Developing
We recommend the following development setup for working with OpenLEADR (this is on Linux / macOS):
bash
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:
bash
./python_env/bin/python3 -m pytest -v test/
Contributing Documentation
Building the documentation
Static documentation can be found in the docs directory. Edit or create new .rst files to add new content using the Restructured Text format. To see the results of your changes, the documentation can be built locally through the command line using the following instructions:
```bash
Ensure that you follow the development setup in the Developing section above before running the following commands
After running this these commands, you should see a new directory docs/_build, which contains the HTML documentation.
For more details, see https://www.sphinx-doc.org/en/master/tutorial/first-steps.html
cd docs make html ```
Then, open your browser to the created local files:
file:///home/<USER>/openleadr-python/docs/_build/html/index.html
Owner
- Name: openLEADR
- Login: OpenLEADR
- Kind: organization
- Website: https://openleadr.org
- Repositories: 3
- Profile: https://github.com/OpenLEADR
A friendly and compliant OpenADR implementation for Python.
GitHub Events
Total
- Issues event: 7
- Watch event: 10
- Issue comment event: 13
- Push event: 33
- Pull request review event: 2
- Pull request event: 5
- Fork event: 16
- Create event: 1
Last Year
- Issues event: 7
- Watch event: 10
- Issue comment event: 13
- Push event: 33
- Pull request review event: 2
- Pull request event: 5
- Fork event: 16
- Create event: 1
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Stan Janssen | s****n@e****l | 323 |
| Stan Janssen | s****n@e****l | 27 |
| johnmeshulam | j****m@g****m | 18 |
| John Mertic | j****c@l****g | 5 |
| john572 | j****n@n****y | 4 |
| Abhishek Gupta | a****a@g****m | 2 |
| Aryaz Eghbali | e****z@g****m | 2 |
| Brent Perdue | p****e@u****m | 2 |
| Juan Aguado | j****o@c****m | 2 |
| Mark Bonicillo | m****o@p****v | 2 |
| Stan Janssen | f****9@u****m | 2 |
| alexcarnero97uma | a****7@u****s | 2 |
| aru | a****u@u****m | 2 |
| ylisko | y****l@n****y | 2 |
| Ciro Chang | c****g@l****m | 1 |
| Mark Bonicillo | m****o@g****m | 1 |
| Sietse Brouwer | S****r@e****l | 1 |
| Stan Janssen | 1****n@u****m | 1 |
| jmuraca | j****a@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 91
- Total pull requests: 36
- Average time to close issues: 4 months
- Average time to close pull requests: 3 months
- Total issue authors: 37
- Total pull request authors: 21
- Average comments per issue: 2.04
- Average comments per pull request: 1.08
- Merged pull requests: 15
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 7
- Pull requests: 9
- Average time to close issues: 3 months
- Average time to close pull requests: N/A
- Issue authors: 4
- Pull request authors: 5
- Average comments per issue: 1.0
- Average comments per pull request: 0.22
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- 00javad00 (15)
- juantxorena (13)
- bbartling (9)
- stan-janssen (7)
- francisrsandoval (6)
- chandank21 (5)
- ProttayMondalAdhikari-eaton (3)
- jason04280428 (2)
- robogeek (2)
- alexcarnero97 (2)
- michal-kowalczyk (2)
- psher619 (1)
- IainEpps (1)
- HaolongEdward (1)
- tnordstrom (1)
Pull Request Authors
- stan-janssen (5)
- parpa (4)
- juantxorena (3)
- 4dahalibut (2)
- gthole (2)
- bjohnson75f (2)
- Borduhh (2)
- bonicim (2)
- aru (2)
- allanlewis (2)
- axmsoftware (2)
- abhigupta2910 (2)
- alexcarnero97 (1)
- robertcragie (1)
- garvish-raval-ext-volansys (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 231 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 6
(may contain duplicates) - Total versions: 108
- Total maintainers: 1
pypi.org: openleadr
Python3 library for building OpenADR Clients (VENs) and Servers (VTNs)
- Homepage: https://openleadr.org
- Documentation: https://openleadr.org/docs
- License: apache-2.0
-
Latest release: 0.5.35
published about 2 years ago
Rankings
Maintainers (1)
proxy.golang.org: github.com/OpenLEADR/openleadr-python
- Documentation: https://pkg.go.dev/github.com/OpenLEADR/openleadr-python#section-documentation
- License: apache-2.0
-
Latest release: v0.5.34
published about 2 years ago
Rankings
proxy.golang.org: github.com/openleadr/openleadr-python
- Documentation: https://pkg.go.dev/github.com/openleadr/openleadr-python#section-documentation
- License: apache-2.0
-
Latest release: v0.5.34
published about 2 years ago
Rankings
Dependencies
- pytest * development
- pytest-asyncio * development
- sphinx * development
- sphinxcontrib-apidoc * development
- termcolor * development
- aiohttp *
- apscheduler *
- jinja2 *
- signxml-openadr ==2.9.1
- xmltodict *
- actions/checkout v2 composite
- actions/setup-python v2 composite