# Adobe Customer Journey API
-----------------------
This is a python wrapper for the Adobe Customer Journey API.\
One important element when starting with CJA API is that you need to have your adobe console.io Project containing access to AEP **and** CJA.\
You cannot use the API without having access to both elements.
## Documentation
Documentation is split in different places:
* Core methods to setup `cjapy`: [main documentation](./docs/main.md)
* Methods provided by the CJA class instance: [cja documentation](./docs/cja.md)
* Workspace class documentation: [Workspace class](./docs/workspace.md)
* RequestCreator class documentation: [RequestCreator class](./docs/requestCreator.md)
* Project class documentation : [Project class](./docs/projects.md)
## Versions
A documentation about the releases information can be found here : [cjapy releases](./docs/releases.md)
## Functionalities
Functionalities that are covered :
* Get Dimensions & Metrics
* Get, Update and Delete Tags & Shares
* Get, Update and Delete Dataview
* Get, Update and Delete Date Ranges
* Get, Update and Delete Filters
* Get Top items for a dimension
* Get, Update and delete projects
* Digest Project Information and analyse them via the `Project` class
* Run a report (by default returning a Workspace instance)
* (BETA) Run a multi dimensional report
## Getting Started
A documentation is provided to get started quickly with the CJA API wrapper in python.\
You can find it here: [get started on `cjapy`](./docs/getting_started.md)\
To install the library with PIP use:
```cli
pip install cjapy
```
or, to get the latest version from github
```cli
python -m pip install --upgrade git+<https://github.com/pitchmuc/cjapy.git#egg=cjapy>
```
## Logging capability
A logging capability is present on the module for debugging purposes.\
There is a proper documentation in place to understand how you can add the logging messages to your runtime.\
[Documentation on logging in cjapy](./docs/logging.md)
## Dependencies
In order to use this API in python, you would need to have those libraries installed :
* pandas
* requests
* json
* PyJWT
* PyJWT[crypto]
* pathlib
* pytest
## Test
TBW
## Others Sources
You can find information about the CJA API here :
* [https://www.adobe.io/cja-apis/docs/api/]
* [https://www.adobe.io/cja-apis/docs/use-cases/]
[1]: https://www.datanalyst.info
Raw data
{
"_id": null,
"home_page": "https://github.com/pitchmuc/cjapy",
"name": "cjapy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "adobe,analytics,API,python",
"author": "Julien Piccini",
"author_email": "Julien Piccini <piccini.julien@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5a/ac/d65b57e18872d5e18040c7c797d07e7958653c9063944da49dfa7f4b3269/cjapy-0.2.2.post3.tar.gz",
"platform": null,
"description": "# Adobe Customer Journey API\r\n\r\n-----------------------\r\n\r\nThis is a python wrapper for the Adobe Customer Journey API.\\\r\nOne important element when starting with CJA API is that you need to have your adobe console.io Project containing access to AEP **and** CJA.\\\r\nYou cannot use the API without having access to both elements.\r\n\r\n## Documentation\r\n\r\nDocumentation is split in different places:\r\n\r\n* Core methods to setup `cjapy`: [main documentation](./docs/main.md)\r\n* Methods provided by the CJA class instance: [cja documentation](./docs/cja.md)\r\n* Workspace class documentation: [Workspace class](./docs/workspace.md)\r\n* RequestCreator class documentation: [RequestCreator class](./docs/requestCreator.md)\r\n* Project class documentation : [Project class](./docs/projects.md)\r\n\r\n## Versions\r\n\r\nA documentation about the releases information can be found here : [cjapy releases](./docs/releases.md)\r\n\r\n## Functionalities\r\n\r\nFunctionalities that are covered :\r\n\r\n* Get Dimensions & Metrics\r\n* Get, Update and Delete Tags & Shares\r\n* Get, Update and Delete Dataview\r\n* Get, Update and Delete Date Ranges\r\n* Get, Update and Delete Filters\r\n* Get Top items for a dimension\r\n* Get, Update and delete projects\r\n* Digest Project Information and analyse them via the `Project` class\r\n* Run a report (by default returning a Workspace instance)\r\n* (BETA) Run a multi dimensional report\r\n\r\n## Getting Started\r\n\r\nA documentation is provided to get started quickly with the CJA API wrapper in python.\\\r\nYou can find it here: [get started on `cjapy`](./docs/getting_started.md)\\\r\nTo install the library with PIP use:\r\n\r\n```cli\r\npip install cjapy\r\n```\r\n\r\nor, to get the latest version from github\r\n\r\n```cli\r\npython -m pip install --upgrade git+<https://github.com/pitchmuc/cjapy.git#egg=cjapy>\r\n```\r\n\r\n## Logging capability\r\n\r\nA logging capability is present on the module for debugging purposes.\\\r\nThere is a proper documentation in place to understand how you can add the logging messages to your runtime.\\\r\n[Documentation on logging in cjapy](./docs/logging.md)\r\n\r\n## Dependencies\r\n\r\nIn order to use this API in python, you would need to have those libraries installed :\r\n\r\n* pandas\r\n* requests\r\n* json\r\n* PyJWT\r\n* PyJWT[crypto]\r\n* pathlib\r\n* pytest\r\n\r\n## Test\r\n\r\nTBW\r\n\r\n## Others Sources\r\n\r\nYou can find information about the CJA API here :\r\n\r\n* [https://www.adobe.io/cja-apis/docs/api/]\r\n* [https://www.adobe.io/cja-apis/docs/use-cases/]\r\n\r\n[1]: https://www.datanalyst.info\r\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Adobe Customer Journey Analytics (CJA) wrapper",
"version": "0.2.2.post3",
"project_urls": {
"Homepage": "https://github.com/pitchmuc/cjapy",
"changelog": "https://github.com/pitchmuc/cjapy/blob/master/docs/releases.md"
},
"split_keywords": [
"adobe",
"analytics",
"api",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11d5448132bcf5480379c08907cd0c20a5e9389b0ff7dafebfb16b7ef1153b95",
"md5": "24f39dfd3fff880ccdb88beaa3cfcf38",
"sha256": "efb1e2004ecdfd39ca034153810b0dd95bab87551f30487ff78ee3f1e671268a"
},
"downloads": -1,
"filename": "cjapy-0.2.2.post3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24f39dfd3fff880ccdb88beaa3cfcf38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 42553,
"upload_time": "2024-02-27T21:23:08",
"upload_time_iso_8601": "2024-02-27T21:23:08.141797Z",
"url": "https://files.pythonhosted.org/packages/11/d5/448132bcf5480379c08907cd0c20a5e9389b0ff7dafebfb16b7ef1153b95/cjapy-0.2.2.post3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5aacd65b57e18872d5e18040c7c797d07e7958653c9063944da49dfa7f4b3269",
"md5": "355f414f7807a20deadb842b6b83fcf5",
"sha256": "e038d37e5923c3233988f5bd381944d1068d388bc678e21ce25ec9e48f7cad48"
},
"downloads": -1,
"filename": "cjapy-0.2.2.post3.tar.gz",
"has_sig": false,
"md5_digest": "355f414f7807a20deadb842b6b83fcf5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 59519,
"upload_time": "2024-02-27T21:23:10",
"upload_time_iso_8601": "2024-02-27T21:23:10.126604Z",
"url": "https://files.pythonhosted.org/packages/5a/ac/d65b57e18872d5e18040c7c797d07e7958653c9063944da49dfa7f4b3269/cjapy-0.2.2.post3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 21:23:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pitchmuc",
"github_project": "cjapy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cjapy"
}
JSON
