# Adobe Experience Platform API made for humans
This repository will document the AEP wrapper on python.
It is focusing on helping accessing the different endpoints of Adobe Experience Platform API.
Documentation on the different endpoints can be found here : [AEP API doc](https://www.adobe.io/apis/experienceplatform/home/api-reference.html)
The wrapper is currently named **aepp**, it stands for Adobe Experience Platform Python.
## Installation
You can install the module directly from a pypi command:
```shell
pip install aepp
```
The version of the wrapper can be seen by the following command (once loaded):
```python
import aepp
aepp.__version__
```
**Consider upgrading regulary**
```shell
pip install aepp --upgrade
```
**NOTE TO PYTHON 3.10.X**
At the moment, not all packages are supported on python 3.10.X, therefore, please use this module with a python 3.9.X version.\
You can use pyenv to generate a local environment if required.
## Getting Started
In order to get started, I have compiled a guide to help you initialize this module and what is required.
You can find this documentation [here](./docs/getting-started.md)
## AEPP docs
At the moment the current wrapper is containing the following sub modules:
* [schema](./docs/schema.md)
* [SchemaManager](./docs/schemaManager.md)
* [FieldGroupManager](./docs/fieldGroupManager.md)
* [DataTypeManager](./docs/dataTypeManager.md)
* [queryservice](./docs/queryservice.md)
* [identity](./docs/identity.md)
* [sandboxes](./docs/sandboxes.md)
* [dataaccess](./docs/dataaccess.md)
* [catalog](./docs/catalog.md)
* [customerprofile](./docs/customerprofile.md)
* [segmentation](./docs/segmentation.md)
* [dataprep](./docs/dataprep.md)
* [flowservice](./docs/flowservice.md)
* [policy](./docs/policy.md)
* [datasets](./docs/datasets.md)
* [ingestion](./docs/ingestion.md)
* [destination Authoring](./docs/destination.md)
* [destination Instance](./docs/destinationinstanceservice.md)
* [observability](./docs/observability.md)
* [accesscontrol](./docs/accesscontrol.md)
* [privacyservice](./docs/privacyservice.md) (see 2nd note below)
* [data hygiene](./docs/hygiene.md)
* [edge](./docs/edge.md)
* [som](./docs/som.md)
Last but not least, the core methods are described here: [main](./docs/main.md)
## Special classes
The wrapper is having a class in all submodule in order to connect to the different service APIs.\
In addition to that, there are other classes that are provided in order to help you working with the API.
### Simple Object Manager
In order to simplify the management of objects via python, especially when dealing with XDM object, we provide an abstraction that aim to simplify the manipulation of complex objects.\
The Simple Object Manager (SOM) is aiming at supporting the creation, manipulation or analysis of XDM messages.\
You can find all information about the methods available of that class (`Som`) in the related documentation.
The Simple Object Manager documentation is located here: [SOM documentation](./docs/som.md)
### InteractiveQuery and InteractiveQuery2 classes
These classes are implemented in the `queryservice` modulebased on the pyGreSQL and psycopg2 module for python.\
It provides you the capability to realize query directly from your local Jupyter notebook and returns a dataframe.
In order to use these classes, you would need to install these module and a PSQL server.
On top of that, you would need to the psql server accessible in the environment path.
### SchemaManager, FieldGroupManager and DataTypeManager
These classes are available from the `schema` module and alloy you to handle the different elements of the schema definition.
You can use them to extract information on your schema definition.
### FlowManager
The FlowManager is part of the `flowservice` module and allows you to group every aspect of a flow in a single class and simplify the search for the relationship between `sourceFlows`, `targetFlow` and the main flow elements.
### PrivacyService module
The privacy service module is part of the AEP python wrapper (`aepp`) but requires a different JWT connection in console.adobe.io.
Be careful that your JWT connection has the correct setup to access this API endpoints.
## Releases
Release notes are accessible [here](./docs/releases.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/adobe/aepp",
"name": "aepp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Julien Piccini",
"author_email": "piccini.julien@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/08/81/6ba63864caf8babb3881d27803ba88580b4b28fb637629f909e21e839067/aepp-0.3.8.tar.gz",
"platform": null,
"description": "# Adobe Experience Platform API made for humans\r\n\r\nThis repository will document the AEP wrapper on python.\r\nIt is focusing on helping accessing the different endpoints of Adobe Experience Platform API.\r\nDocumentation on the different endpoints can be found here : [AEP API doc](https://www.adobe.io/apis/experienceplatform/home/api-reference.html)\r\nThe wrapper is currently named **aepp**, it stands for Adobe Experience Platform Python.\r\n\r\n## Installation\r\n\r\nYou can install the module directly from a pypi command:\r\n\r\n```shell\r\npip install aepp\r\n```\r\n\r\nThe version of the wrapper can be seen by the following command (once loaded):\r\n\r\n```python\r\nimport aepp\r\naepp.__version__\r\n\r\n```\r\n\r\n**Consider upgrading regulary**\r\n\r\n```shell\r\npip install aepp --upgrade\r\n```\r\n\r\n**NOTE TO PYTHON 3.10.X**\r\n\r\nAt the moment, not all packages are supported on python 3.10.X, therefore, please use this module with a python 3.9.X version.\\\r\nYou can use pyenv to generate a local environment if required.\r\n\r\n## Getting Started\r\n\r\nIn order to get started, I have compiled a guide to help you initialize this module and what is required.\r\nYou can find this documentation [here](./docs/getting-started.md)\r\n\r\n## AEPP docs\r\n\r\nAt the moment the current wrapper is containing the following sub modules:\r\n\r\n* [schema](./docs/schema.md)\r\n * [SchemaManager](./docs/schemaManager.md)\r\n * [FieldGroupManager](./docs/fieldGroupManager.md)\r\n * [DataTypeManager](./docs/dataTypeManager.md)\r\n* [queryservice](./docs/queryservice.md)\r\n* [identity](./docs/identity.md)\r\n* [sandboxes](./docs/sandboxes.md)\r\n* [dataaccess](./docs/dataaccess.md)\r\n* [catalog](./docs/catalog.md)\r\n* [customerprofile](./docs/customerprofile.md)\r\n* [segmentation](./docs/segmentation.md)\r\n* [dataprep](./docs/dataprep.md)\r\n* [flowservice](./docs/flowservice.md)\r\n* [policy](./docs/policy.md)\r\n* [datasets](./docs/datasets.md)\r\n* [ingestion](./docs/ingestion.md)\r\n* [destination Authoring](./docs/destination.md)\r\n* [destination Instance](./docs/destinationinstanceservice.md)\r\n* [observability](./docs/observability.md)\r\n* [accesscontrol](./docs/accesscontrol.md)\r\n* [privacyservice](./docs/privacyservice.md) (see 2nd note below)\r\n* [data hygiene](./docs/hygiene.md)\r\n* [edge](./docs/edge.md)\r\n* [som](./docs/som.md)\r\n\r\nLast but not least, the core methods are described here: [main](./docs/main.md)\r\n\r\n## Special classes\r\n\r\nThe wrapper is having a class in all submodule in order to connect to the different service APIs.\\\r\nIn addition to that, there are other classes that are provided in order to help you working with the API.\r\n\r\n### Simple Object Manager\r\n\r\nIn order to simplify the management of objects via python, especially when dealing with XDM object, we provide an abstraction that aim to simplify the manipulation of complex objects.\\\r\nThe Simple Object Manager (SOM) is aiming at supporting the creation, manipulation or analysis of XDM messages.\\\r\nYou can find all information about the methods available of that class (`Som`) in the related documentation.\r\n\r\nThe Simple Object Manager documentation is located here: [SOM documentation](./docs/som.md)\r\n\r\n### InteractiveQuery and InteractiveQuery2 classes\r\n\r\nThese classes are implemented in the `queryservice` modulebased on the pyGreSQL and psycopg2 module for python.\\\r\nIt provides you the capability to realize query directly from your local Jupyter notebook and returns a dataframe.\r\nIn order to use these classes, you would need to install these module and a PSQL server.\r\nOn top of that, you would need to the psql server accessible in the environment path.\r\n\r\n### SchemaManager, FieldGroupManager and DataTypeManager\r\n\r\nThese classes are available from the `schema` module and alloy you to handle the different elements of the schema definition.\r\nYou can use them to extract information on your schema definition.\r\n\r\n### FlowManager\r\n\r\nThe FlowManager is part of the `flowservice` module and allows you to group every aspect of a flow in a single class and simplify the search for the relationship between `sourceFlows`, `targetFlow` and the main flow elements.\r\n\r\n### PrivacyService module\r\n\r\nThe privacy service module is part of the AEP python wrapper (`aepp`) but requires a different JWT connection in console.adobe.io.\r\nBe careful that your JWT connection has the correct setup to access this API endpoints.\r\n\r\n## Releases\r\n\r\nRelease notes are accessible [here](./docs/releases.md).\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Package to manage AEP API endpoint and some helper functions",
"version": "0.3.8",
"project_urls": {
"Homepage": "https://github.com/adobe/aepp"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e33a8916b19dd98e522434b849afa673c24ddf891e0c04416ec0f9f081b88b37",
"md5": "8b8de248bb3261df4c983faf4522d41d",
"sha256": "6a7cbc761e353fefe71610ce88091f54ed467c89cd9ad5deadedceda30c31a0d"
},
"downloads": -1,
"filename": "aepp-0.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b8de248bb3261df4c983faf4522d41d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 190434,
"upload_time": "2024-12-09T11:51:51",
"upload_time_iso_8601": "2024-12-09T11:51:51.451887Z",
"url": "https://files.pythonhosted.org/packages/e3/3a/8916b19dd98e522434b849afa673c24ddf891e0c04416ec0f9f081b88b37/aepp-0.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "08816ba63864caf8babb3881d27803ba88580b4b28fb637629f909e21e839067",
"md5": "98ba24db7205d8b57037fd04327444cb",
"sha256": "08656e335a475a64abd2ed90e8acc3fd7211e22c6c1ce3ff417fb3a1c7869691"
},
"downloads": -1,
"filename": "aepp-0.3.8.tar.gz",
"has_sig": false,
"md5_digest": "98ba24db7205d8b57037fd04327444cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 156922,
"upload_time": "2024-12-09T11:51:54",
"upload_time_iso_8601": "2024-12-09T11:51:54.742900Z",
"url": "https://files.pythonhosted.org/packages/08/81/6ba63864caf8babb3881d27803ba88580b4b28fb637629f909e21e839067/aepp-0.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 11:51:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adobe",
"github_project": "aepp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [
{
"name": "pytest",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "PyJWT",
"specs": [
[
">=",
"1.7.1"
]
]
},
{
"name": "PyJWT",
"specs": [
[
">=",
"1.7.1"
]
]
},
{
"name": "tenacity",
"specs": []
},
{
"name": "deprecation",
"specs": []
}
],
"lcname": "aepp"
}
JSON
