Metadata-Version: 2.1
Name: supergood
Version: 1.1.2
Summary: The Python client for Supergood
Author: Alex Klarfeld
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: httpx
Requires-Dist: jsonpickle
Requires-Dist: pydash ==7.0.1
Requires-Dist: python-dotenv ==1.0.0
Requires-Dist: requests
Requires-Dist: tldextract >=5
Requires-Dist: urllib3 <2.0,>=1.26
Provides-Extra: test
Requires-Dist: requests ; extra == 'test'
Requires-Dist: urllib3 <2.0,>=1.26 ; extra == 'test'
Requires-Dist: pytest ==7.2.1 ; extra == 'test'
Requires-Dist: pytest-httpserver ==1.0.8 ; extra == 'test'
Requires-Dist: python-dotenv ==1.0.0 ; extra == 'test'
Requires-Dist: Werkzeug ; extra == 'test'
Requires-Dist: jsonpickle ==3.0.1 ; extra == 'test'
Requires-Dist: pytest-mock ==3.10.0 ; extra == 'test'

# Python

The Supergood Python client connects Supergood to your Python application. Follow these steps to integrate with the Python client.

## 1. Install the Supergood library

```bash
pip install supergood
```

## 2. Initialize the Supergood Library

**Environment variables**

Set the environment variables `SUPERGOOD_CLIENT_ID` and `SUPERGOOD_CLIENT_SECRET` using the API keys generated in the [getting started instructions](../getting-started.md).

Initialize the Supergood client at the root of your application, or anywhere you're making API calls.

```python
from supergood import Client

Client()
```

**Passing keys**

You can also pass the API keys in manually without setting environment variables.

Replace `<CLIENT_ID>` and `<CLIENT_SECRET>` with the API keys you generated in the [getting started instructions](../getting-started.md).

```python
from supergood import Client

Client(client_id="<CLIENT_ID>", client_secret_id="<CLIENT_SECRET>")
```

Note: If your application makes use of the `multiprocessing` library to make API calls, you'll need to initialize a client for each `Process`.&#x20;

## 3. Monitor your API calls

You're all set to use Supergood!

Head back to your [dashboard](https://dashboard.supergood.ai) to start monitoring your API calls and receiving reports.

## Links

* [Supergood PyPi Project](https://pypi.org/project/supergood/)
* [Supergood\_py Source Code](https://github.com/supergoodsystems/supergood-py)
