pyelexon

Name	pyelexon JSON
Version	0.2.7 JSON
	download
home_page	https://github.com/atsangarides/pyelexon
Summary
upload_time	2023-06-01 11:04:32
maintainer
docs_url	None
author	atsangarides
requires_python	>=3.8,<4.0
license	MIT
keywords	api energy
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # pyelexon

Simple python wrapper for the Elexon BMRS API.

[![](https://img.shields.io/badge/python-3.8-blue.svg)](https://github.com/pyenv/pyenv)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

## Getting started

* Register on the Elexon BMRS [data portal](https://www.elexonportal.co.uk/news/latest?cachebust=q3pzb5uiac)
and retrieve your `api_key`

* Example usage
```python
from datetime import date
from pyelexon import Elexon

api_key = "123456"
report = "DETSYSPRICES"
params = {
    "settlement_date": "2021-01-01",
    "settlement_period": 1
}

elexon = Elexon(api_key)
# returns content of response
r: bytes = elexon.fetch_data(report, params)
```
Example with report specific method
```python
from datetime import date
from pyelexon import Elexon

api_key = "123456"
report = "DETSYSPRICES"


elexon = Elexon(api_key)
# returns content of response
r: bytes = elexon.get_detsysprices(
    report,
    settlement_date=date(2021, 1, 1),
    settlement_period=1
)
```

## Tested reports

* `DETSYSPRICES`
* `DYNBMDATA`
* `PHYBMDATA`

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/atsangarides/pyelexon",
    "name": "pyelexon",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "api,energy",
    "author": "atsangarides",
    "author_email": "andreas_tsangarides@hotmail.com",
    "download_url": "https://files.pythonhosted.org/packages/65/a4/348b3ebd5630052005744b0a6f7a0ba88814ae72365ffc666d4087583b3a/pyelexon-0.2.7.tar.gz",
    "platform": null,
    "description": "# pyelexon\n\nSimple python wrapper for the Elexon BMRS API.\n\n[![](https://img.shields.io/badge/python-3.8-blue.svg)](https://github.com/pyenv/pyenv)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n\n## Getting started\n\n* Register on the Elexon BMRS [data portal](https://www.elexonportal.co.uk/news/latest?cachebust=q3pzb5uiac)\nand retrieve your `api_key`\n\n* Example usage\n```python\nfrom datetime import date\nfrom pyelexon import Elexon\n\napi_key = \"123456\"\nreport = \"DETSYSPRICES\"\nparams = {\n    \"settlement_date\": \"2021-01-01\",\n    \"settlement_period\": 1\n}\n\nelexon = Elexon(api_key)\n# returns content of response\nr: bytes = elexon.fetch_data(report, params)\n```\nExample with report specific method\n```python\nfrom datetime import date\nfrom pyelexon import Elexon\n\napi_key = \"123456\"\nreport = \"DETSYSPRICES\"\n\n\nelexon = Elexon(api_key)\n# returns content of response\nr: bytes = elexon.get_detsysprices(\n    report,\n    settlement_date=date(2021, 1, 1),\n    settlement_period=1\n)\n```\n\n## Tested reports\n\n* `DETSYSPRICES`\n* `DYNBMDATA`\n* `PHYBMDATA`\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "",
    "version": "0.2.7",
    "project_urls": {
        "Homepage": "https://github.com/atsangarides/pyelexon",
        "Repository": "https://github.com/atsangarides/pyelexon"
    },
    "split_keywords": [
        "api",
        "energy"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8b29d6e07219027a9b08eb5f11dd045e6222c40330331c753263dab58f53bdcc",
                "md5": "5148a6a9f9100222e3eb679bd67ee0b4",
                "sha256": "bb60d47f9efd4a68077c8df0de7dc28b8117b3968091afa822eb2ac5e2ffe81b"
            },
            "downloads": -1,
            "filename": "pyelexon-0.2.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5148a6a9f9100222e3eb679bd67ee0b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 5725,
            "upload_time": "2023-06-01T11:04:31",
            "upload_time_iso_8601": "2023-06-01T11:04:31.179167Z",
            "url": "https://files.pythonhosted.org/packages/8b/29/d6e07219027a9b08eb5f11dd045e6222c40330331c753263dab58f53bdcc/pyelexon-0.2.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "65a4348b3ebd5630052005744b0a6f7a0ba88814ae72365ffc666d4087583b3a",
                "md5": "67ef4d9fe58d843449301fb8726593b3",
                "sha256": "84db8278f1339686affe0796df0035e3c3f51c145337de3c8a5981cc3d3c65cf"
            },
            "downloads": -1,
            "filename": "pyelexon-0.2.7.tar.gz",
            "has_sig": false,
            "md5_digest": "67ef4d9fe58d843449301fb8726593b3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 5245,
            "upload_time": "2023-06-01T11:04:32",
            "upload_time_iso_8601": "2023-06-01T11:04:32.971065Z",
            "url": "https://files.pythonhosted.org/packages/65/a4/348b3ebd5630052005744b0a6f7a0ba88814ae72365ffc666d4087583b3a/pyelexon-0.2.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-01 11:04:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "atsangarides",
    "github_project": "pyelexon",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pyelexon"
}