# LCPDelta Python Package
This is the python wrapper to interact with all LCPDelta products through their API or DPS. To get started, install the latest version of the LCPDelta package.
To find out more about LCPDelta's data products, click [**here**][LCPDelta_data_portal_link].
To find out more about Enact, click [**here**][Enact_Homepage].
## Enact API and DPS Instructions
Full instructions on how to utilise Enact's full API and DPS can be found [**here**][Enact_instructions_link]. Below are some examples to get you started.
### Enact Series API Example Code
```python
from lcp_delta import enact
from datetime import date
username = "insert_username_here"
public_api_key = "insert_public_api_key_here"
api_helper = enact.APIHelper(username, public_api_key)
# Example dates
from_date= date(2022,4,1)
to_date = date(2023,5,31)
# Example series
series_id = "LcpDemandvsGrid"
response = api_helper.get_series_data(
series_id,
from_date,
to_date,
country_id = "Gb",
time_zone_id="UTC"
)
print(response)
```
### Enact DPS Example Code
```python
from lcp_delta import enact
def handle_new_information(x):
# A callback function that will be invoked with the received series updates.
# The function should accept one argument, which will be the data received from the series updates.
print(x)
username = "insert_username_here"
public_api_key = "insert_public_api_key_here"
dps_helper = enact.DPSHelper(username, public_api_key)
# Input method to handle any update to the series, alongside the series ID, that can be found on Enact.
dps_helper.subscribe_to_series_updates(handle_new_information, "RealtimeDemand")
message = None
while message != "exit()":
message = input(">> ")
#Terminate the connection at the end
dps_helper.terminate_hub_connection()
```
### FLEXtrack API Example Code
```python
import lcp_delta.flextrack as flextrack
from datetime import datetime as dt
user = "insert_username_here"
api_key = "insert_public_api_key_here"
api_helper = flextrack.APIHelper(user, api_key)
response = api_helper.get_exporter_data(
date_from=dt(2022, 11, 1),
date_to=dt(2023, 10, 31),
countries=['Austria'],
products=["RegelleistungFcrProcuredFourHourly","RegelleistungFcrProcuredDaily","RegelleistungAfrrProcured"],
directions=["Symmetric", "Upward", "Downward"],
market='Availability',
metrics=['Volume', 'Price'],
aggregation_types=['Average', 'Average'],
granularity='Monthly'
)
response.head
```
[Enact_instructions_link]: https://api.lcpdelta.com/
[LCPDelta_data_portal_link]: https://portal.lcpdelta.com/
[Enact_Homepage]: https://enact.lcpdelta.com/
[FLEXtrack_Homepage]: https://flextrack.lcpdelta.com/
# Contributing
Check out our [contribution guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "LCPDelta",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "LCPDelta, Enact, Flextrack, Storetrack",
"author": null,
"author_email": "LCP Delta <enact.helpdesk@lcp.uk.com>",
"download_url": "https://files.pythonhosted.org/packages/64/1e/56d2b0ec2b4fda84e5a83fbce8de20321b2368a4ba161e4eb3d76321de62/lcpdelta-1.3.6.tar.gz",
"platform": null,
"description": "# LCPDelta Python Package\nThis is the python wrapper to interact with all LCPDelta products through their API or DPS. To get started, install the latest version of the LCPDelta package.\n\nTo find out more about LCPDelta's data products, click [**here**][LCPDelta_data_portal_link].\nTo find out more about Enact, click [**here**][Enact_Homepage].\n\n## Enact API and DPS Instructions\n\nFull instructions on how to utilise Enact's full API and DPS can be found [**here**][Enact_instructions_link]. Below are some examples to get you started.\n\n### Enact Series API Example Code\n\n```python\nfrom lcp_delta import enact\nfrom datetime import date\n\nusername = \"insert_username_here\"\npublic_api_key = \"insert_public_api_key_here\"\n\napi_helper = enact.APIHelper(username, public_api_key)\n\n# Example dates\nfrom_date= date(2022,4,1)\nto_date = date(2023,5,31)\n\n# Example series\nseries_id = \"LcpDemandvsGrid\"\n\nresponse = api_helper.get_series_data(\n series_id,\n from_date,\n to_date,\n country_id = \"Gb\",\n time_zone_id=\"UTC\"\n)\n\nprint(response)\n```\n\n### Enact DPS Example Code\n\n```python\nfrom lcp_delta import enact\n\ndef handle_new_information(x):\n # A callback function that will be invoked with the received series updates.\n # The function should accept one argument, which will be the data received from the series updates.\n print(x)\n\nusername = \"insert_username_here\"\npublic_api_key = \"insert_public_api_key_here\"\n\ndps_helper = enact.DPSHelper(username, public_api_key)\n# Input method to handle any update to the series, alongside the series ID, that can be found on Enact.\ndps_helper.subscribe_to_series_updates(handle_new_information, \"RealtimeDemand\")\n\nmessage = None\nwhile message != \"exit()\":\n message = input(\">> \")\n\n#Terminate the connection at the end\ndps_helper.terminate_hub_connection()\n```\n\n### FLEXtrack API Example Code\n\n```python\nimport lcp_delta.flextrack as flextrack\nfrom datetime import datetime as dt\n\nuser = \"insert_username_here\"\napi_key = \"insert_public_api_key_here\"\n\napi_helper = flextrack.APIHelper(user, api_key)\n\nresponse = api_helper.get_exporter_data(\n date_from=dt(2022, 11, 1),\n date_to=dt(2023, 10, 31),\n countries=['Austria'],\n products=[\"RegelleistungFcrProcuredFourHourly\",\"RegelleistungFcrProcuredDaily\",\"RegelleistungAfrrProcured\"],\n directions=[\"Symmetric\", \"Upward\", \"Downward\"],\n market='Availability',\n metrics=['Volume', 'Price'],\n aggregation_types=['Average', 'Average'],\n granularity='Monthly'\n)\n\nresponse.head\n```\n\n[Enact_instructions_link]: https://api.lcpdelta.com/\n[LCPDelta_data_portal_link]: https://portal.lcpdelta.com/\n[Enact_Homepage]: https://enact.lcpdelta.com/\n[FLEXtrack_Homepage]: https://flextrack.lcpdelta.com/\n\n# Contributing\n\nCheck out our [contribution guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).\n",
"bugtrack_url": null,
"license": null,
"summary": "LCPDelta Python Package",
"version": "1.3.6",
"project_urls": {
"Homepage": "https://portal.lcpdelta.com/"
},
"split_keywords": [
"lcpdelta",
" enact",
" flextrack",
" storetrack"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4c13b260be500d337a92be56e80268a061073b4e60ebe2504649a5177778f15",
"md5": "d50e6f09c590237a951225bab8c802c7",
"sha256": "7a095c764a49359ce44b4f390b869e45b025af362a7cd04ae1495bc3b72084aa"
},
"downloads": -1,
"filename": "LCPDelta-1.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d50e6f09c590237a951225bab8c802c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 32897,
"upload_time": "2024-09-02T14:51:44",
"upload_time_iso_8601": "2024-09-02T14:51:44.364638Z",
"url": "https://files.pythonhosted.org/packages/c4/c1/3b260be500d337a92be56e80268a061073b4e60ebe2504649a5177778f15/LCPDelta-1.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "641e56d2b0ec2b4fda84e5a83fbce8de20321b2368a4ba161e4eb3d76321de62",
"md5": "6f11c1a9b4b24c323a36251f4c1dca28",
"sha256": "0f75b8e37107856a29388f9edb7bfbeece31c0b7c99524fb06a895a66e2ec5ed"
},
"downloads": -1,
"filename": "lcpdelta-1.3.6.tar.gz",
"has_sig": false,
"md5_digest": "6f11c1a9b4b24c323a36251f4c1dca28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 24523,
"upload_time": "2024-09-02T14:51:45",
"upload_time_iso_8601": "2024-09-02T14:51:45.389487Z",
"url": "https://files.pythonhosted.org/packages/64/1e/56d2b0ec2b4fda84e5a83fbce8de20321b2368a4ba161e4eb3d76321de62/lcpdelta-1.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 14:51:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "lcpdelta"
}
JSON