py2adobe-reporting 0.0.15__tar.gz

py2adobe_reporting-0.0.15/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

py2adobe_reporting-0.0.15/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

py2adobe_reporting-0.0.15/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 James Mitchell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py2adobe_reporting-0.0.15/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: py2adobe_reporting
+Version: 0.0.15
+Summary: Data Engineering tool for accessing Adobe CJA Reporting API
+Project-URL: Homepage, https://github.com/jaytmii/py2adobe_reporting_package
+Project-URL: Repository, https://github.com/jaytmii/py2adobe_reporting_package
+Project-URL: Issues, https://github.com/jaytmii/py2adobe_reporting_package/issues
+Author-email: James Mitchell <jaytmii@gmail.com>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: plotly>=6.5.0
+Requires-Dist: pytz>=2024.1
+Requires-Dist: requests>=2.32.3
+Provides-Extra: dev
+Requires-Dist: pylint>=4.0.4; extra == 'dev'
+Requires-Dist: pytest>=8.2.2; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# py2adobe_reporting
+
+A Python wrapper for Adobe Customer Journey Analytics (CJA) Reporting API that enables analysts to easily extract and analyze data programmatically.
+
+## Features
+
+- **Time Series Reports** - Daily and monthly aggregated metrics
+- **Multi-Metric Analysis** - Pull up to 5 metrics in a single report
+- **Dimension Breakdowns** - Break down metrics by multiple dimensions
+- **Top Items Analysis** - Get top 10 dimension items with optional search
+- **Pagination Support** - Handle large datasets with automatic pagination (up to 50,000 rows per page)
+- **Server-to-Server Authentication** - Secure OAuth 2.0 authentication
+
+## Installation
+
+```bash
+pip install py2adobe_reporting
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/jaytmii/py2adobe_reporting_package.git
+cd py2adobe_reporting_package
+pip install -e .
+```
+
+## Requirements
+
+- Python >= 3.10
+- Adobe CJA API credentials (OAuth 2.0 Server-to-Server)
+
+## Quick Start
+
+### 1. Set Up Authentication
+
+Create a JSON configuration file with your Adobe credentials:
+
+```json
+{
+  "client_secret": "your-client-secret",
+  "defaultHeaders": {
+    "x-api-key": "your-api-key",
+    "x-gw-ims-org-id": "your-org-id"
+  },
+  "company_id": "your-company-id",
+  "scopes": "api_scopes",
+  "ims_host": "ims",
+  "token_url": "token_url"
+}
+```
+
+### 2. Authenticate
+
+```python
+from py2adobe_reporting.auth import s2s_auth
+
+# Authenticate and get environment object
+env = s2s_auth("path/to/config.json")
+```
+
+### 3. Generate Headers
+
+```python
+from py2Adobe_reporting.auth import cja_oauth_headers
+
+# Create headers for API calls
+headers = cja_oauth_headers("path/to/config.json", env.token)
+```
+
+### 4. Pull a Report
+
+```python
+from py2adobe_reporting.cja_functions.reporting_management import Reporting
+
+# Initialize reporting class
+reporting = Reporting()
+
+# Get daily time series report
+df = reporting.daily_time_series_report(
+    headers=headers,
+    data_view_id="your-data-view-id",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    metric="metrics/visits"
+)
+
+print(df.head())
+```
+
+## Available Functions
+
+### Time Series Reports
+- `monthly_time_series_report()` - Month-level aggregated metrics
+- `daily_time_series_report()` - Day-level aggregated metrics
+
+### Multi-Dimensional Reports
+- `five_metrics_report()` - Pull 5 metrics with a dimension
+- `breakdown_report()` - Break down a metric by two dimensions
+- `get_all_rows_report()` - Get all rows for custom request body
+
+### Utility Functions
+- `get_single_call_report()` - Single API call with custom body
+- `get_total_table_rows()` - Get row count for a table
+- `get_total_table_pages()` - Calculate total pages needed
+- `get_top_ten_dimension_items()` - Get top 10 items for a dimension
+
+## Documentation
+
+For detailed function parameters and examples, see:
+- [Reporting Management Documentation](docs/reporting_management.md)
+
+## Example Use Cases
+
+### Get Daily Visits
+```python
+df = reporting.daily_time_series_report(
+    headers=headers,
+    data_view_id="your-data-view-id",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    metric="metrics/visits"
+)
+```
+
+### Get Monthly Visits
+
+```python
+df = reporting.monthly_time_series_report(
+    headers=headers,
+    data_view_id="dv_123",
+    start_date="2024-01-01",
+    end_date="2024-12-31",
+    metric="metrics/visits"
+)
+```
+
+### Breakdown by Multiple Dimensions
+
+```python
+df = reporting.breakdown_report(
+    headers=headers,
+    data_view_id="dv_123",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    dimension="variables/page",
+    metric="metrics/visits",
+    dim_rows_per_page=50,
+    breakdown_dim="variables/browser",
+    breakdown_rows_per_page=50
+)
+```
+
+### Search for Dimension Items
+
+```python
+df = reporting.get_top_ten_dimension_items(
+    headers=headers,
+    data_view_id="dv_123",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    dimension="variables/page",
+    search_type="contains",
+    contains_term="( CONTAINS 'product' )"
+)
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Author
+
+James Mitchell - jaytmii@gmail.com
+

py2adobe_reporting-0.0.15/README.md

@@ -0,0 +1,179 @@
+# py2adobe_reporting
+
+A Python wrapper for Adobe Customer Journey Analytics (CJA) Reporting API that enables analysts to easily extract and analyze data programmatically.
+
+## Features
+
+- **Time Series Reports** - Daily and monthly aggregated metrics
+- **Multi-Metric Analysis** - Pull up to 5 metrics in a single report
+- **Dimension Breakdowns** - Break down metrics by multiple dimensions
+- **Top Items Analysis** - Get top 10 dimension items with optional search
+- **Pagination Support** - Handle large datasets with automatic pagination (up to 50,000 rows per page)
+- **Server-to-Server Authentication** - Secure OAuth 2.0 authentication
+
+## Installation
+
+```bash
+pip install py2adobe_reporting
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/jaytmii/py2adobe_reporting_package.git
+cd py2adobe_reporting_package
+pip install -e .
+```
+
+## Requirements
+
+- Python >= 3.10
+- Adobe CJA API credentials (OAuth 2.0 Server-to-Server)
+
+## Quick Start
+
+### 1. Set Up Authentication
+
+Create a JSON configuration file with your Adobe credentials:
+
+```json
+{
+  "client_secret": "your-client-secret",
+  "defaultHeaders": {
+    "x-api-key": "your-api-key",
+    "x-gw-ims-org-id": "your-org-id"
+  },
+  "company_id": "your-company-id",
+  "scopes": "api_scopes",
+  "ims_host": "ims",
+  "token_url": "token_url"
+}
+```
+
+### 2. Authenticate
+
+```python
+from py2adobe_reporting.auth import s2s_auth
+
+# Authenticate and get environment object
+env = s2s_auth("path/to/config.json")
+```
+
+### 3. Generate Headers
+
+```python
+from py2Adobe_reporting.auth import cja_oauth_headers
+
+# Create headers for API calls
+headers = cja_oauth_headers("path/to/config.json", env.token)
+```
+
+### 4. Pull a Report
+
+```python
+from py2adobe_reporting.cja_functions.reporting_management import Reporting
+
+# Initialize reporting class
+reporting = Reporting()
+
+# Get daily time series report
+df = reporting.daily_time_series_report(
+    headers=headers,
+    data_view_id="your-data-view-id",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    metric="metrics/visits"
+)
+
+print(df.head())
+```
+
+## Available Functions
+
+### Time Series Reports
+- `monthly_time_series_report()` - Month-level aggregated metrics
+- `daily_time_series_report()` - Day-level aggregated metrics
+
+### Multi-Dimensional Reports
+- `five_metrics_report()` - Pull 5 metrics with a dimension
+- `breakdown_report()` - Break down a metric by two dimensions
+- `get_all_rows_report()` - Get all rows for custom request body
+
+### Utility Functions
+- `get_single_call_report()` - Single API call with custom body
+- `get_total_table_rows()` - Get row count for a table
+- `get_total_table_pages()` - Calculate total pages needed
+- `get_top_ten_dimension_items()` - Get top 10 items for a dimension
+
+## Documentation
+
+For detailed function parameters and examples, see:
+- [Reporting Management Documentation](docs/reporting_management.md)
+
+## Example Use Cases
+
+### Get Daily Visits
+```python
+df = reporting.daily_time_series_report(
+    headers=headers,
+    data_view_id="your-data-view-id",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    metric="metrics/visits"
+)
+```
+
+### Get Monthly Visits
+
+```python
+df = reporting.monthly_time_series_report(
+    headers=headers,
+    data_view_id="dv_123",
+    start_date="2024-01-01",
+    end_date="2024-12-31",
+    metric="metrics/visits"
+)
+```
+
+### Breakdown by Multiple Dimensions
+
+```python
+df = reporting.breakdown_report(
+    headers=headers,
+    data_view_id="dv_123",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    dimension="variables/page",
+    metric="metrics/visits",
+    dim_rows_per_page=50,
+    breakdown_dim="variables/browser",
+    breakdown_rows_per_page=50
+)
+```
+
+### Search for Dimension Items
+
+```python
+df = reporting.get_top_ten_dimension_items(
+    headers=headers,
+    data_view_id="dv_123",
+    start_date="2024-01-01",
+    end_date="2024-01-31",
+    dimension="variables/page",
+    search_type="contains",
+    contains_term="( CONTAINS 'product' )"
+)
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Author
+
+James Mitchell - jaytmii@gmail.com
+

py2adobe_reporting-0.0.15/docs/reporting_management.md

@@ -0,0 +1,86 @@
+# reporting_management
+-----------------------
+This module is used by the CJA Reporting API and provides significant value for extracting data
+
+## Functionality
+* Get Single Call Report
+* Get Total Table Rows
+* Get Total Table Pages
+* Get All Rows Report
+* Monthly Time Series Report
+* Daily Time Series Report
+* Five Metrics Report
+* Breakdown Report
+* Get Top Ten Dimension Items
+
+
+## Dependencies
+* pandas
+* requests
+* numpy
+* plotly
+
+
+## Common Input Parameters
+* headers are generated using the auth file and are required for all calls
+* req_num is an optional parameter that can be used to set the number of retries
+* data_view_id is the unique identifier of the dataView
+* start_date this is formatted in the standard `YYYY-MM-DD` format
+* end_date this is formatted in the standard `YYYY-MM-DD` format
+* metric this is the schema location for a single metric
+* metrics this is a list of metrics, it must contain five separate entries in list format
+* rows_per_page allows you to set the number of rows per page of pull, can accept a max of int 50000
+* limit this is differentiated as an input name, but is functionally the same as rows_per_page
+
+## Get Single Call Report
+```python
+get_single_call_report(headers=dict, body=dict, req_num=int)
+```
+
+## Get Total Table Rows
+```python
+get_total_table_rows(headers=dict, body=dict, req_num=int)
+```
+
+## Get Total Table Pages
+```python
+get_total_table_pages(headers=dict, body=dict, req_num=int)
+```
+
+## Get All Rows Report
+```python
+get_all_rows_report(headers=dict, body=dict, rows_per_page=int, req_num=int)
+```
+
+## Monthly Time Series Report
+```python
+monthly_time_series_report(headers=dict, data_view_id=str, start_date=str, end_date=str, metric=str, req_num=int, limit=int)
+```
+* This will get a month based report for a single metric
+
+## Daily Time Series Report
+```python
+daily_time_series_report(headers=dict, data_view_id=str, start_date=str, end_date=str, metric=str, req_num=int, limit=int)
+```
+* This will get a day's based report for a single metric
+
+## Five Metrics Report
+```python
+five_metrics_report(headers=dict, data_view_id=str, start_date=str, end_date=str, metrics=list, dimension=str, rows_per_page=int, req_num=int, limit=int)
+```
+* You must include five metrics in the entry for this to work and in a list format
+
+## Breakdown Report
+```python
+breakdown_report(headers=dict, data_view_id=str, start_date=str, end_date=str, dimension=str, metric=str, dim_rows_per_page=int, breakdown_dim=str, breakdown_rows_per_page=int, req_num=int, limit=int)
+```
+* This will breakdown a single metric by two dimensions, rows_per_page will set the rows per page for each dimension
+
+## Get Top Ten Dimension Items 
+```python
+get_top_ten_dimension_items(headers=dict, data_view_id=str, start_date=str, end_date=str, dimension=str, search_type=str, contains_term=str, req_num=int)
+```
+* dimension uses the full schema path
+* search_type currently should be set to `contain` to access search functionality
+* contains_term must use the following formatting "( CONTAINS 'click' )"
+

py2adobe_reporting-0.0.15/py2adobe_reporting/__init__.py

@@ -0,0 +1,8 @@
+"""Setting package imports"""
+from py2adobe_reporting import http_client
+from py2adobe_reporting import auth
+from py2adobe_reporting.cja_functions import reporting_management
+from py2adobe_reporting import reporting_api
+from py2adobe_reporting import utils
+from py2adobe_reporting import json_extractor
+from .__version__ import __version__