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 compiled 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
- identity
- sandboxes
- dataaccess
- catalog
- customerprofile
- segmentation
- dataprep
- flowservice
- policy
- datasets
- ingestion
- destination Authoring
- destination Instance
- observability
- accesscontrol
- privacyservice (see 2nd note below)
- data hygiene
- edge
Last but not least, the core methods are described here: main
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.
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.
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.
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.
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.
Release notes are accessible here.