smart-energy.awattar-api


Namesmart-energy.awattar-api JSON
Version 0.2.0 PyPI version JSON
download
home_page
SummaryA python library to access the Awattar Energy Price API.
upload_time2023-02-07 08:31:26
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords awattar kfw api cloud
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Awattar 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 awattar_api.awattar_api import AwattarApi

awattar_api = AwattarApi('provide_api_url')
# or you can define additional optional parameters
# awattar_api = AwattarApi('provide_api_url', timeout=10)

print(awattar_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 awattar_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=awattar_api tests
```

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "smart-energy.awattar-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "awattar,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/d1/c5/3cc69a183f928fadfd7f0066adf781de34addf8d7566b76ebcd472efe1fd/smart-energy.awattar-api-0.2.0.tar.gz",
    "platform": null,
    "description": "# Awattar 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 awattar_api.awattar_api import AwattarApi\n\nawattar_api = AwattarApi('provide_api_url')\n# or you can define additional optional parameters\n# awattar_api = AwattarApi('provide_api_url', timeout=10)\n\nprint(awattar_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 awattar_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=awattar_api tests\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A python library to access the Awattar Energy Price API.",
    "version": "0.2.0",
    "split_keywords": [
        "awattar",
        "kfw",
        "api",
        "cloud"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "00518733aa0a62bf3ff4aa02c45e1bccb961bef734f1b44ebcdeb97bd074e639",
                "md5": "9b8e5842013261d0d4d2f6e8cef499b4",
                "sha256": "8acad2a5f58914e55a4c6c0306e92383eb315d73860a77ce7b3c2d121793b6eb"
            },
            "downloads": -1,
            "filename": "smart_energy.awattar_api-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9b8e5842013261d0d4d2f6e8cef499b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 15717,
            "upload_time": "2023-02-07T08:31:24",
            "upload_time_iso_8601": "2023-02-07T08:31:24.312695Z",
            "url": "https://files.pythonhosted.org/packages/00/51/8733aa0a62bf3ff4aa02c45e1bccb961bef734f1b44ebcdeb97bd074e639/smart_energy.awattar_api-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d1c53cc69a183f928fadfd7f0066adf781de34addf8d7566b76ebcd472efe1fd",
                "md5": "c7d8211e49608009510298fc42978c7f",
                "sha256": "b27f74c539fbd702ba9364094dfffdbd666f8b0909e00e57a3ff34811c3c0088"
            },
            "downloads": -1,
            "filename": "smart-energy.awattar-api-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c7d8211e49608009510298fc42978c7f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 16000,
            "upload_time": "2023-02-07T08:31:26",
            "upload_time_iso_8601": "2023-02-07T08:31:26.260199Z",
            "url": "https://files.pythonhosted.org/packages/d1/c5/3cc69a183f928fadfd7f0066adf781de34addf8d7566b76ebcd472efe1fd/smart-energy.awattar-api-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-07 08:31:26",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "smart-energy.awattar-api"
}
Elapsed time: 0.22590s