Metadata-Version: 2.3
Name: findly.unified-reporting-sdk
Version: 0.7.17
Summary: 
License: GPL-3.0-only
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: aiocache (>=0.12.2,<0.13.0)
Requires-Dist: backoff (>=2.2.1,<3.0.0)
Requires-Dist: facebook-business (>=22.0.5,<23.0.0)
Requires-Dist: google-analytics-admin (>=0.24.0,<0.25.0)
Requires-Dist: google-analytics-data (>=0.18.18,<0.19.0)
Requires-Dist: google-api-python-client (>=2.169.0,<3.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: protobuf (>=6.33.5,<7.0.0)
Requires-Dist: sqlglot (>=26.17.1,<27.0.0)
Description-Content-Type: text/markdown

# Unified Reporting SDK (URS)

![URS Banner](https://uploads-ssl.webflow.com/6425b0eaf5047adcb91592d7/65f1e58e7f52c5f271a66074_OSS_Banner.jpg)

The Unified Reporting SDK (URS) aids in generating reports across various platforms, beginning with Google Analytics 4 (GA4) and Facebook Ads, with the plan to include more integrations soon. URS abstracts away the complexities of interfacing with different APIs, providing a seamless reporting experience.

## Table of Contents

- [Installation](#installation)
- [Quick Start](#quick-start)
- [Contributing](#contributing)
- [License](#license)

## Installation

Install URS directly from PyPI:

```bash
pip install findly-unified-reporting-sdk
```

This command installs the latest version of URS as a wheel package, making it ready to use in your projects without needing any additional package management tools.

## Contributing

We welcome contributions from the community! Whether it's in the form of feature enhancements, bug fixes, documentation improvements, or additional integrations, your input is highly valued.

### Setting Up Your Development Environment

URS uses Poetry for dependency management and packaging, ensuring a consistent development environment. To contribute, you'll need to set up your environment:

1. **Install Poetry**:

   If you haven't already installed Poetry, you can do so using `pipx` for an isolated installation:

   ```bash
   pipx install poetry
   ```

2. **Clone the Repository**:

   Clone the repository to your local machine to start making changes:

   ```bash
   git clone URL_TO_REPOSITORY
   cd unified-reporting-sdk
   ```

3. **Install Dependencies**:

   Make sure you're using version 3.9 or above:

   ```bash
   poetry env use 3.9
   poetry env info
   ```

   Install the necessary dependencies to get started:

   ```bash
   poetry install
   ```

### Publishing (For Maintainers)

If you have permissions to publish new versions to PyPI, configure your PyPI token and publish using Poetry:

```bash
poetry config pypi-token.pypi YOUR_PYPI_API_TOKEN
poetry publish
```

## License

URS is made available under the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
