Metadata-Version: 2.4
Name: nudgey
Version: 0.1.0
Summary: Python SDK for the Nudgey API
Home-page: https://nudgey.ai
Author: Nudgey
Author-email: brandon@nudgey.ai
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: httpx>=0.25.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Nudgey

Python SDK for the Nudgey API.

## Install

```bash
pip install nudgey
```

## Quickstart

```python
import os

from nudgey import NudgeyAPIError, NudgeyClient

client = NudgeyClient(api_key=os.environ["NUDGEY_API_KEY"])

try:
    result = client.track(
        "partner_smoke_test_user",
        "sdk_installed",
        {"source": "python-sdk"},
    )
    print(result)
except NudgeyAPIError as exc:
    print(f"Nudgey request failed: {exc}")
```

## What To Expect

The SDK uses the `X-Nudgey-Key` header for authentication and talks to `https://api.nudgey.ai` by default.

If you want to target a different environment, pass `base_url` when constructing the client.

## Next Steps

1. Create your API key in the Nudgey dashboard.
2. Send your first production event.
3. Add webhook handling if your integration consumes nudge delivery events.
