Metadata-Version: 2.4
Name: trophy
Version: 1.0.22
Summary: A Python library for the Trophy API
License: MIT
Project-URL: Homepage, https://github.com/trophyso/trophy-python
Project-URL: Repository, https://github.com/trophyso/trophy-python
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: httpx
Requires-Dist: pydantic
Requires-Dist: typing
Requires-Dist: dataclasses
Requires-Dist: typing_extensions
Dynamic: license-file

# Trophy Python SDK

The Trophy Python SDK provides convenient access to the Trophy API from applications written in the
Python language.

Trophy provides APIs and tools for adding gamification to your application, keeping users engaged
through rewards, achievements, streaks, and personalized communication.

## Installation

You can install the package via pip:

```bash
pip install trophy
```

## Usage

The package needs to be configured with your account's API key which is available in the Trophy
dashboard.

```python
from trophy import EventRequestUser, TrophyApi

client = TrophyApi(
    api_key="YOUR_API_KEY",
)

client.metrics.event(
    key="words-written",
    user=EventRequestUser(
        id="18",
        email="jk.rowling@harrypotter.com",
        tz="Europe/London",
    ),
    value=750.0,
)
```

## Documentation

See the [Trophy API Docs](https://docs.trophy.so) for more
information on the accessible endpoints.
