# Ibp2py - Python library for SAP IBP
This is a Python library designed to make it easier to interact with the SAP Integrated Business Planning (IBP) API.
## Installation
You can install ibpy using pip:
```bash
`pip install ibpy
```
## Usage
To use ibpy, first create an instance of the `ibpy` class using your SAP IBP username and password:
```python
from ibpy import ibpy
username = "YOUR_IBP_USERNAME"
password = "YOUR_IBP_PASSWORD"
host = 'YOUR_HOST_URL'
connection = Ibp2py(username, password, host)
```
### Extracting Master Data
Here is an example of how to extract master data:
```python
PlanningAreaID = 'SAP01'
VersionID = "BASE"
MasterDataTypeID = "M3LOCATION"
PlanningAreaDescr = "Planning"
VersionName = "Base Line"
select = '*'
data = connection.masterdata(MasterDataTypeID, select=select, PlanningAreaID=PlanningAreaID, VersionID=VersionID, PlanningAreaDescr=PlanningAreaDescr, VersionName=VersionName)
```
### Extracting Telemetry Data
Here is an example of how to extract telemetry data:
```python
data = connection.telemetry('PlanningView')
```
### Extracting Key Figure Data
Here is an example of how to extract key figure data:
```python
filters="(PERIODID0_TSTAMP ge datetime'2023-04-01T00:00:00' and PERIODID0_TSTAMP lt datetime'2023-07-02T00:00:00')"+ " and CONSENSUSDEMAND gt 0"
PlanningAreaID = 'SAP01'
MasterData = 'PRDID,CUSTID'
KeyFigures = 'CONSENSUSDEMAND'
data = connection.keyfigure(PlanningAreaID, MasterData, KeyFigures,filters=filters)
```
## Contact Information
For any issues or queries related to ibpy, feel free to reach out:
- Author: Pedro Rastha
- Email: [pedrorastha@gmail.com](mailto:pedrorastha@gmail.com)
- LinkedIn: [@pedrorastha](https://www.linkedin.com/in/pedrorastha)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)
**Note:** This library is open source and is not sponsored or supported by SAP.
Raw data
{
"_id": null,
"home_page": "https://github.com/pedrorastha/ibp2py",
"name": "Ibp2py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "SAP IBP API ODATA",
"author": "Pedro Rastha",
"author_email": "pedrorastha@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/30/6d/b2b3dbf076e7b82a8c8291bd9f02e85e6177201309d2e51788d3398c8e89/Ibp2py-1.0.4.tar.gz",
"platform": null,
"description": "# Ibp2py - Python library for SAP IBP\r\n\r\nThis is a Python library designed to make it easier to interact with the SAP Integrated Business Planning (IBP) API.\r\n\r\n## Installation\r\n\r\nYou can install ibpy using pip:\r\n\r\n```bash\r\n`pip install ibpy\r\n```\r\n## Usage\r\n\r\nTo use ibpy, first create an instance of the `ibpy` class using your SAP IBP username and password:\r\n\r\n```python\r\nfrom ibpy import ibpy \r\nusername = \"YOUR_IBP_USERNAME\" \r\npassword = \"YOUR_IBP_PASSWORD\" \r\nhost = 'YOUR_HOST_URL' \r\nconnection = Ibp2py(username, password, host)\r\n```\r\n\r\n### Extracting Master Data\r\n\r\nHere is an example of how to extract master data:\r\n\r\n```python\r\nPlanningAreaID = 'SAP01' \r\nVersionID = \"BASE\" \r\nMasterDataTypeID = \"M3LOCATION\" \r\nPlanningAreaDescr = \"Planning\" \r\nVersionName = \"Base Line\" \r\nselect = '*' \r\ndata = connection.masterdata(MasterDataTypeID, select=select, PlanningAreaID=PlanningAreaID, VersionID=VersionID, PlanningAreaDescr=PlanningAreaDescr, VersionName=VersionName)\r\n```\r\n\r\n### Extracting Telemetry Data\r\n\r\nHere is an example of how to extract telemetry data:\r\n\r\n```python\r\ndata = connection.telemetry('PlanningView')\r\n```\r\n### Extracting Key Figure Data\r\n\r\nHere is an example of how to extract key figure data:\r\n\r\n```python\r\nfilters=\"(PERIODID0_TSTAMP ge datetime'2023-04-01T00:00:00' and PERIODID0_TSTAMP lt datetime'2023-07-02T00:00:00')\"+ \" and CONSENSUSDEMAND gt 0\" \r\nPlanningAreaID = 'SAP01' \r\nMasterData = 'PRDID,CUSTID' \r\nKeyFigures = 'CONSENSUSDEMAND' \r\ndata = connection.keyfigure(PlanningAreaID, MasterData, KeyFigures,filters=filters)\r\n```\r\n## Contact Information\r\n\r\nFor any issues or queries related to ibpy, feel free to reach out:\r\n\r\n- Author: Pedro Rastha\r\n- Email: [pedrorastha@gmail.com](mailto:pedrorastha@gmail.com)\r\n- LinkedIn: [@pedrorastha](https://www.linkedin.com/in/pedrorastha)\r\n\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\n## License\r\n\r\n[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)\r\n\r\n**Note:** This library is open source and is not sponsored or supported by SAP.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "SAP Data Retrieval and Processing Library for IBP",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/pedrorastha/ibp2py"
},
"split_keywords": [
"sap",
"ibp",
"api",
"odata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dada6ea9ed22c263690b1ef4e2cfa9ef8f84ccd70eb80877168cc5987982f94d",
"md5": "ec10a54501bec56b142b6f27eeccafbb",
"sha256": "6f3ed6da1417cd5e632d5b955a91eb32c689572abbe54c7e645dfd9478431929"
},
"downloads": -1,
"filename": "Ibp2py-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec10a54501bec56b142b6f27eeccafbb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19455,
"upload_time": "2023-07-27T04:26:58",
"upload_time_iso_8601": "2023-07-27T04:26:58.963393Z",
"url": "https://files.pythonhosted.org/packages/da/da/6ea9ed22c263690b1ef4e2cfa9ef8f84ccd70eb80877168cc5987982f94d/Ibp2py-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "306db2b3dbf076e7b82a8c8291bd9f02e85e6177201309d2e51788d3398c8e89",
"md5": "0dd6f217bfc7de13acddf6650a6bcf07",
"sha256": "e30f5d483257f37c3998e639a9d25c0a8ae6bea9ec0255799e85ffd145f7db08"
},
"downloads": -1,
"filename": "Ibp2py-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "0dd6f217bfc7de13acddf6650a6bcf07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11983,
"upload_time": "2023-07-27T04:27:00",
"upload_time_iso_8601": "2023-07-27T04:27:00.727478Z",
"url": "https://files.pythonhosted.org/packages/30/6d/b2b3dbf076e7b82a8c8291bd9f02e85e6177201309d2e51788d3398c8e89/Ibp2py-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 04:27:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pedrorastha",
"github_project": "ibp2py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ibp2py"
}
JSON
