# pyngeso
Simple python wrapper for the National Grid ESO Portal.
[](https://github.com/pyenv/pyenv)
[](https://github.com/psf/black)
[](https://github.com/pre-commit/pre-commit)
## Getting started
* Example usage
```python
from pyngeso import NgEso
resource = "historic-day-ahead-demand-forecast"
date_col = "TARGETDATE"
start_date = "2018-01-01"
end_date = "2018-01-01"
client = NgEso(resource)
# returns content of response
r: bytes = client.query(date_col=date_col, start_date=start_date, end_date=end_date)
```
## Tested reports
### Queryable via NG's api
* `historic-day-ahead-demand-forecast`
* `day-ahead-demand-forecast`
* `historic-2day-ahead-demand-forecast`
* `2day-ahead-demand-forecast`
* `historic-2-14-days-ahead-demand-forecast`
* `historic-day-ahead-wind-forecast`
* `day-ahead-wind-forecast`
* `14-days-ahead-wind-forecast`
* `demand-data-update`
* `dc-results-summary`
* `dc-dr-dm-linear-orders`
* `historic-demand-data-{year}` [2009-2022]
* `historic-frequency-data` [Jan21-Jan22]
* `transmission-entry-capacity-tec-register`
* `dx-eac-eso-results-summary`
* `dx-eac-eso-sell-orders`
* `dx-eac-eso-buy-orders`
* `br-eac-eso-results-summary`
* `br-eac-eso-sell-orders`
* `br-eac-eso-buy-orders`
* `br-eac-eso-results-by-units`
### Download of files
* `historic-generation-mix`
Raw data
{
"_id": null,
"home_page": "https://github.com/atsangarides/pyngeso",
"name": "pyngeso",
"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/b2/3c/96e225ef6e027202a72c2557a435b2cbdc682e85cf896cb90772e4305194/pyngeso-0.3.7.tar.gz",
"platform": null,
"description": "# pyngeso\n\nSimple python wrapper for the National Grid ESO Portal.\n\n[](https://github.com/pyenv/pyenv)\n[](https://github.com/psf/black)\n[](https://github.com/pre-commit/pre-commit)\n\n## Getting started\n\n\n* Example usage\n```python\nfrom pyngeso import NgEso\n\nresource = \"historic-day-ahead-demand-forecast\"\ndate_col = \"TARGETDATE\"\nstart_date = \"2018-01-01\"\nend_date = \"2018-01-01\"\n\nclient = NgEso(resource)\n# returns content of response\nr: bytes = client.query(date_col=date_col, start_date=start_date, end_date=end_date)\n```\n\n## Tested reports\n\n### Queryable via NG's api\n* `historic-day-ahead-demand-forecast`\n* `day-ahead-demand-forecast`\n* `historic-2day-ahead-demand-forecast`\n* `2day-ahead-demand-forecast`\n* `historic-2-14-days-ahead-demand-forecast`\n* `historic-day-ahead-wind-forecast`\n* `day-ahead-wind-forecast`\n* `14-days-ahead-wind-forecast`\n* `demand-data-update`\n* `dc-results-summary`\n* `dc-dr-dm-linear-orders`\n* `historic-demand-data-{year}` [2009-2022]\n* `historic-frequency-data` [Jan21-Jan22]\n* `transmission-entry-capacity-tec-register`\n* `dx-eac-eso-results-summary`\n* `dx-eac-eso-sell-orders`\n* `dx-eac-eso-buy-orders`\n* `br-eac-eso-results-summary`\n* `br-eac-eso-sell-orders`\n* `br-eac-eso-buy-orders`\n* `br-eac-eso-results-by-units`\n\n\n### Download of files\n* `historic-generation-mix`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple python wrapper for the National Grid ESO Portal",
"version": "0.3.7",
"project_urls": {
"Homepage": "https://github.com/atsangarides/pyngeso",
"Repository": "https://github.com/atsangarides/pyngeso"
},
"split_keywords": [
"api",
"energy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a44b8aa1d98f597e841c4a001a5bcf2eccb0e013e5a46e90f09719176e65bd54",
"md5": "3f4cc3933ca58ac959eb0e3e4769d95f",
"sha256": "d52ffca4f89d60bf7213ed96cf5a661c60466a5ec893de523392fbf85a59894f"
},
"downloads": -1,
"filename": "pyngeso-0.3.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f4cc3933ca58ac959eb0e3e4769d95f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 7899,
"upload_time": "2024-03-19T16:50:12",
"upload_time_iso_8601": "2024-03-19T16:50:12.539403Z",
"url": "https://files.pythonhosted.org/packages/a4/4b/8aa1d98f597e841c4a001a5bcf2eccb0e013e5a46e90f09719176e65bd54/pyngeso-0.3.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b23c96e225ef6e027202a72c2557a435b2cbdc682e85cf896cb90772e4305194",
"md5": "f077d1df2030d85879d1f434dc3aa737",
"sha256": "7e8ecf4a9bd489f936875bbc1800f1d8fc3d04a32e351923da29570f51da9c63"
},
"downloads": -1,
"filename": "pyngeso-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "f077d1df2030d85879d1f434dc3aa737",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7746,
"upload_time": "2024-03-19T16:50:13",
"upload_time_iso_8601": "2024-03-19T16:50:13.737349Z",
"url": "https://files.pythonhosted.org/packages/b2/3c/96e225ef6e027202a72c2557a435b2cbdc682e85cf896cb90772e4305194/pyngeso-0.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 16:50:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "atsangarides",
"github_project": "pyngeso",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyngeso"
}
JSON
