# LCPDelta Python Package
The LCPDelta Python package provides streamlined access to data available from the [**Enact**][Enact_Homepage], [**FLEXtrack**][FLEXtrack_Homepage] APIs.
It contains helper methods for requesting data from our API endpoints or subscribing to push groups, all of which are detailed on our [**developer documentation site**][Api_Docs].
### Installation
The Python package requires Python 3.10 or greater, and can be installed via:
```
pip install LCPDelta
```
### Usage
The Enact and FLEXtrack modules can be imported as follows:
```python
from lcp_delta import enact
import lcp_delta.flextrack as flextrack
```
The package requires a username and API key, which will be emailed on signup. Helper objects can then be instantiated as follows:
```python
username = "insert_username_here"
public_api_key = "insert_public_api_key_here"
enact_api_helper = enact.APIHelper(username, public_api_key)
enact_dps_helper = enact.DPSHelper(username, public_api_key)
flextrack_api_helper = flextrack.APIHelper(username, public_api_key)
```
From here, you can call any of the available helper methods to retrieve data in one call or listen for pushes. The following example makes use of Enact's Series Data endpoint:
```python
from_date = date(2023,10,1)
to_date = date(2024,10,1)
series_id = "LcpDemandvsGrid"
response = enact_api_helper.get_series_data(
series_id,
from_date,
to_date,
country_id = "Gb",
time_zone_id="UTC"
)
print(response.head(5))
```
Check out our [**API guides**][Api_Docs] for detailed instructions on getting started with the API, our [**Recipes page**][Api_Recipes] for example scripts using our Python package, and our [**API reference**][Api_Reference] for details on each specific API endpoint (and corresponding Python package method).
Full documentation of our API and Python package can be found on our [**documentation site**][Api_Docs].
[Api_Docs]: https://api.lcpdelta.com/
[Api_Recipes]: https://api.lcpdelta.com/recipes
[Api_Reference]: https://api.lcpdelta.com/reference
[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/61/2e/60564979ebf227e61632519e0fbc8121bbc59c82eaa3e0b7ef02896b4238/lcpdelta-2.0.1.tar.gz",
"platform": null,
"description": "# LCPDelta Python Package\nThe LCPDelta Python package provides streamlined access to data available from the [**Enact**][Enact_Homepage], [**FLEXtrack**][FLEXtrack_Homepage] APIs.\n\nIt contains helper methods for requesting data from our API endpoints or subscribing to push groups, all of which are detailed on our [**developer documentation site**][Api_Docs].\n\n### Installation\nThe Python package requires Python 3.10 or greater, and can be installed via:\n\n```\npip install LCPDelta\n```\n\n### Usage\n\nThe Enact and FLEXtrack modules can be imported as follows:\n\n```python\nfrom lcp_delta import enact\nimport lcp_delta.flextrack as flextrack\n```\n\nThe package requires a username and API key, which will be emailed on signup. Helper objects can then be instantiated as follows:\n```python\nusername = \"insert_username_here\"\npublic_api_key = \"insert_public_api_key_here\"\n\nenact_api_helper = enact.APIHelper(username, public_api_key)\nenact_dps_helper = enact.DPSHelper(username, public_api_key)\nflextrack_api_helper = flextrack.APIHelper(username, public_api_key)\n```\n\nFrom here, you can call any of the available helper methods to retrieve data in one call or listen for pushes. The following example makes use of Enact's Series Data endpoint:\n```python\n\nfrom_date = date(2023,10,1)\nto_date = date(2024,10,1)\n\nseries_id = \"LcpDemandvsGrid\"\n\nresponse = enact_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.head(5))\n```\n\nCheck out our [**API guides**][Api_Docs] for detailed instructions on getting started with the API, our [**Recipes page**][Api_Recipes] for example scripts using our Python package, and our [**API reference**][Api_Reference] for details on each specific API endpoint (and corresponding Python package method).\n\nFull documentation of our API and Python package can be found on our [**documentation site**][Api_Docs].\n\n[Api_Docs]: https://api.lcpdelta.com/\n[Api_Recipes]: https://api.lcpdelta.com/recipes\n[Api_Reference]: https://api.lcpdelta.com/reference\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": "2.0.1",
"project_urls": {
"Homepage": "https://portal.lcpdelta.com/"
},
"split_keywords": [
"lcpdelta",
" enact",
" flextrack",
" storetrack"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a40304a6a4390378a0e9b26760cf9cea6a98238c0bde6ceecafd02c386eb9e01",
"md5": "c75eff126d2d793c5a40830af0f6af13",
"sha256": "1506d121adb75e672bef9aab56eed8f0511256df6346d05e8f900ffff07165d5"
},
"downloads": -1,
"filename": "LCPDelta-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c75eff126d2d793c5a40830af0f6af13",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 33475,
"upload_time": "2024-11-11T12:04:34",
"upload_time_iso_8601": "2024-11-11T12:04:34.316606Z",
"url": "https://files.pythonhosted.org/packages/a4/03/04a6a4390378a0e9b26760cf9cea6a98238c0bde6ceecafd02c386eb9e01/LCPDelta-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "612e60564979ebf227e61632519e0fbc8121bbc59c82eaa3e0b7ef02896b4238",
"md5": "404b6c492a4549d1f8e6a5e327130375",
"sha256": "e16b75641e25723c3fa8f207e74445db69941f7fd8e79c90745e9b98f765d4e7"
},
"downloads": -1,
"filename": "lcpdelta-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "404b6c492a4549d1f8e6a5e327130375",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 25333,
"upload_time": "2024-11-11T12:04:35",
"upload_time_iso_8601": "2024-11-11T12:04:35.618162Z",
"url": "https://files.pythonhosted.org/packages/61/2e/60564979ebf227e61632519e0fbc8121bbc59c82eaa3e0b7ef02896b4238/lcpdelta-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-11 12:04:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "lcpdelta"
}
JSON