| Name | smart-energy.green-energy-api JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | A python library to access the Awattar Energy Price API. |
| upload_time | 2023-01-19 14:08:48 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
green_energy
kfw
api
cloud
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# smart_energy.green_energy_api
A python library to access the Awattar Api. Refer also to the [Awattar Energy Price API](https://www.awattar.de/). This repo provides functionality for:
- Getting Energy Price forecast forecast information.
## Installing the library locally
Python 3 is recommended for this project.
```bash
python -m pip install -e .
```
> **This is needed for the first time when working with the library/examples/tests.**
## Example usage
```bash
ENERGY_DATA_API_URL="https://api.awattar.de" python3 examples/simple.py
```
or
```python
from green_energy_api.green_energy_api import GreenEnergyApi
green_energy_api = GreenEnergyApi('provide_api_url')
# or you can define additional optional parameters
# green_energy_api = GreenEnergyApi('provide_api_url', timeout=10)
print(green_energy_api.get_electricity_price())
```
## Development
### Installing required pip packages
```bash
python pip install -r requirements.txt
pre-commit install -t pre-push
```
### Linting
```bash
pylint green_energy_api/*.py tests/*.py examples/*.py
```
### Unit testing
```bash
pytest tests/*.py
# show logs
pytest -o log_cli=true
# code coverage
pytest --durations=10 --cov-report term-missing --cov=green_energy_api tests
```
Raw data
{
"_id": null,
"home_page": "",
"name": "smart-energy.green-energy-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "green_energy,kfw,api,cloud",
"author": "",
"author_email": "Ingmar Mueller <ingmar.mueller@kfw.de>, Mario Macai <mario.macai@accenture.com>, Melissa Schmidt <melissa.schmidt@accenture.com>, Georgia Moldovan <georgia.moldovan@accenture.com>, Felix Stark <felix.stark@kfw.de>",
"download_url": "https://files.pythonhosted.org/packages/7c/5f/aa891845ed419e854f1d35a690b2e5657152c976571605c31d1b652496d7/smart_energy.green_energy_api-0.1.0.tar.gz",
"platform": null,
"description": "# smart_energy.green_energy_api\n\nA python library to access the Awattar Api. Refer also to the [Awattar Energy Price API](https://www.awattar.de/). This repo provides functionality for:\n\n- Getting Energy Price forecast forecast information.\n\n## Installing the library locally\n\nPython 3 is recommended for this project.\n\n```bash\npython -m pip install -e .\n```\n\n> **This is needed for the first time when working with the library/examples/tests.**\n\n## Example usage\n\n```bash\nENERGY_DATA_API_URL=\"https://api.awattar.de\" python3 examples/simple.py\n```\n\nor\n\n```python\nfrom green_energy_api.green_energy_api import GreenEnergyApi\n\ngreen_energy_api = GreenEnergyApi('provide_api_url')\n# or you can define additional optional parameters\n# green_energy_api = GreenEnergyApi('provide_api_url', timeout=10)\n\nprint(green_energy_api.get_electricity_price())\n```\n\n## Development\n\n### Installing required pip packages\n\n```bash\npython pip install -r requirements.txt\npre-commit install -t pre-push\n```\n\n### Linting\n\n```bash\npylint green_energy_api/*.py tests/*.py examples/*.py\n```\n\n### Unit testing\n\n```bash\npytest tests/*.py\n\n# show logs\npytest -o log_cli=true\n\n# code coverage\npytest --durations=10 --cov-report term-missing --cov=green_energy_api tests\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A python library to access the Awattar Energy Price API.",
"version": "0.1.0",
"split_keywords": [
"green_energy",
"kfw",
"api",
"cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a6e77442a6dc3053a2ec72c8ec8fc3eef51b7dd0273b8cf878e9d7065221219",
"md5": "670f845645511fa24c0397c464c566f4",
"sha256": "378299cc9711c3ddb48096cb7d44949ca41da4c37c7d27c55eefe04bf8c87074"
},
"downloads": -1,
"filename": "smart_energy.green_energy_api-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "670f845645511fa24c0397c464c566f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 15831,
"upload_time": "2023-01-19T14:08:46",
"upload_time_iso_8601": "2023-01-19T14:08:46.428319Z",
"url": "https://files.pythonhosted.org/packages/9a/6e/77442a6dc3053a2ec72c8ec8fc3eef51b7dd0273b8cf878e9d7065221219/smart_energy.green_energy_api-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c5faa891845ed419e854f1d35a690b2e5657152c976571605c31d1b652496d7",
"md5": "522da5ac1299aff76135614faa66a838",
"sha256": "50afd9d282ce58e2f97f24cece318b3ceefcaf7260666cc06fbfbf4d0ed967ef"
},
"downloads": -1,
"filename": "smart_energy.green_energy_api-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "522da5ac1299aff76135614faa66a838",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15196,
"upload_time": "2023-01-19T14:08:48",
"upload_time_iso_8601": "2023-01-19T14:08:48.284052Z",
"url": "https://files.pythonhosted.org/packages/7c/5f/aa891845ed419e854f1d35a690b2e5657152c976571605c31d1b652496d7/smart_energy.green_energy_api-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-19 14:08:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "smart-energy.green-energy-api"
}
