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 The wrapper is currently named aepp, it stands for Adobe Experience Platform Python.
You can install the module directly from a pypi command:
pip install aeppThe version of the wrapper can be seen by the following command (once loaded):
import aepp
aepp.__version__Consider upgrading regulary
pip install aepp --upgradeNOTE 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.
In order to get started, I have compile a guide to help you initialize this module and what is required. You can find this documentation here
At the moment the current wrapper is containing the following sub modules:
- schema
- queryservice (see note below)
- identity
- sandboxes
- dataaccess
- catalog
- customerprofile
- segmentation
- dataprep
- flowservice
- policy
- datasets
- ingestion
- destination Authoring
- destination Instance
- observability
- accesscontrol
- sensei
- privacyservice (see 2nd note below)
Last but not least, the core methods are described here: main
The queryservice Module contains 2 classes:
The QueryService class is the wrapper around the AEP Query Service API.
It provides access to the different endpoints available from the API.
Use-Case example : At the moment the capability to scheduled query is only accessible from the API.
These classes are based 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.
The privacy service module is part of the AEP python wrapper 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.
Release notes are accessible here.