green-energy-api


Namegreen-energy-api JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryA python library to access the Awattar Energy Price API.
upload_time2023-01-20 08:49:00
maintainer
docs_urlNone
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. 
            # 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 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": "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/b0/2d/0bdc56d300b4ac39bd12d5e92a802daa4750150bc2ac23b7c580f93426f5/green_energy_api-0.1.0.tar.gz",
    "platform": null,
    "description": "# 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 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": "d387b15f36056e9cdc73f85fdfc02d624390802bec0b8282086fb461dab94a9f",
                "md5": "105c972bf37055c0f89feed2099ecc9e",
                "sha256": "e7117ba713ea731039e84a17463aa2b047587102708682a7e5b9a01c7aa4d64e"
            },
            "downloads": -1,
            "filename": "green_energy_api-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "105c972bf37055c0f89feed2099ecc9e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 17238,
            "upload_time": "2023-01-20T08:48:59",
            "upload_time_iso_8601": "2023-01-20T08:48:59.111537Z",
            "url": "https://files.pythonhosted.org/packages/d3/87/b15f36056e9cdc73f85fdfc02d624390802bec0b8282086fb461dab94a9f/green_energy_api-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b02d0bdc56d300b4ac39bd12d5e92a802daa4750150bc2ac23b7c580f93426f5",
                "md5": "be183b9eae2b93f20c2220727c234aee",
                "sha256": "300c336c03e7c6a6b8ef8a0cba686a9ba6fdea1b69908f9d09efaeb43a273331"
            },
            "downloads": -1,
            "filename": "green_energy_api-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "be183b9eae2b93f20c2220727c234aee",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 16241,
            "upload_time": "2023-01-20T08:49:00",
            "upload_time_iso_8601": "2023-01-20T08:49:00.574813Z",
            "url": "https://files.pythonhosted.org/packages/b0/2d/0bdc56d300b4ac39bd12d5e92a802daa4750150bc2ac23b7c580f93426f5/green_energy_api-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-20 08:49:00",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "green-energy-api"
}
Elapsed time: 0.03461s