Metadata-Version: 2.4
Name: hopscotch_python_sdk
Version: 0.1.0
Summary: Python SDK for Hopscotch API
Author-email: Hopscotch <support@hopscotch.trade>
License-Expression: MIT
Project-URL: Homepage, https://hopscotch.trade
Project-URL: Documentation, https://hopscotch.trade/docs/api
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: annotated-types>=0.8.0
Requires-Dist: anyio>=4.15.1
Requires-Dist: certifi>=2026.7.22
Requires-Dist: h11>=0.16.0
Requires-Dist: httpcore>=1.0.9
Requires-Dist: httpx>=0.28.1
Requires-Dist: idna>=3.19
Requires-Dist: pydantic>=2.13.5
Requires-Dist: pydantic_core>=2.46.5
Requires-Dist: typing-inspection>=0.4.4
Requires-Dist: typing_extensions>=4.16.0

# hopscotch_python_sdk

> Python SDK for the Hopscotch API

## Installation

```bash
pip install --upgrade hopscotch_python_sdk
```

## Setup

```python
from hopscotch_python_sdk import Hopscotch

hs = Hopscotch('<api_key'>, '<client_id>', '<client_secret>')

user = hs.get_caller();
```

## Authentication
To authenticate with the API, create a new **API key**, **Client ID** and **Client Secret** in the **[Settings menu](https://hopscotch.trade/settings/api)** of the [Hopscotch app](https://hopscotch.trade).

> Do not store any of your credentials in source control or where someone else can see them. Anyone with access to your credentials can read and make changes to your Hopscotch account data.

The SDK will automatically use the provided `client_id` and `client_secret` to generate and refresh the OAuth2.0 JWT token to authenticate the underlying API calls.

## License

1. This software is provided under the **MIT License** | *Free for commercial and non-commercial use.*

1. This software is provided *"as is"* without warranty of any kind.

1. By using this software and by interacting with any Hopscotch service, you agree to our [Privacy Policy](https://hopscotch.trade/legal/privacy) and [Terms of Service](https://hopscotch.trade/legal/tos).

## Links

- [PyPI registry](https://pypi.org/project/hopscotch_python_sdk)
- [API Documentation](https://hopscotch.trade/docs/api)
- [Support](https://hopscotch.trade/support) | [support@hopscotch.trade](mailto:support@hopscotch.trade)
- [Hopscotch](https://hopscotch.trade)
- [Privacy Policy](https://hopscotch.trade/legal/privacy)
- [Terms of Service](https://hopscotch.trade/legal/tos)
