Metadata-Version: 2.4
Name: saasplatform-sdk
Version: 1.0.1
Summary: Official Python SDK for SaaS Platform API
Home-page: https://pypi.org/project/saasplatform-sdk/
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <support@saasplatform.app>
Project-URL: Homepage, https://saasplatform.app
Project-URL: Documentation, https://docs.saasplatform.app
Project-URL: Repository, https://github.com/saasplatform-repo/saas-platform-community
Project-URL: Issues, https://github.com/saasplatform-repo/saas-platform-community/issues
Keywords: OpenAPI,OpenAPI-Generator,SaaS Platform API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# saasplatform-sdk

Official Python client for [SaaS Platform](https://saasplatform.app) — OpenAPI-generated access to workspace APIs with JWT and API key authentication.

**Current release:** `saasplatform-sdk@1.0.1` on [PyPI](https://pypi.org/project/saasplatform-sdk/).

## Installation

```bash
pip install saasplatform-sdk
```

On macOS with Homebrew Python, use a virtual environment (system Python is externally managed):

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install saasplatform-sdk
```

## Quick start

```python
import saasplatform_sdk
from saasplatform_sdk import Configuration, ApiClient
from saasplatform_sdk.api.auth_api import AuthApi

configuration = Configuration(
    host="https://api.saasplatform.app",
    access_token="YOUR_JWT_ACCESS_TOKEN",
)
with ApiClient(configuration) as api_client:
    auth = AuthApi(api_client)
    # Call generated methods, e.g. auth.auth_controller_get_me()
```

`host` is the API **origin only** (e.g. `https://api.saasplatform.app` or `http://localhost:3001`). Do not append `/api/v1` — generated paths already include it.

Obtain a JWT from `POST /api/v1/auth/login`, or use an API key where supported by the endpoint.

## API reference

This package is generated from the platform OpenAPI spec. For browsable endpoint and model documentation, use the hosted API reference:

- **Documentation:** [docs.saasplatform.app](https://docs.saasplatform.app)
- **OpenAPI spec:** [docs.saasplatform.app/openapi.json](https://docs.saasplatform.app/openapi.json)

Generated markdown under `docs/` in the source tree is for local development only; PyPI does not host those pages.

## Repository & support

| Link | URL |
|------|-----|
| Repository | [github.com/saasplatform-repo/saas-platform-community](https://github.com/saasplatform-repo/saas-platform-community) |
| Issues | [github.com/saasplatform-repo/saas-platform-community/issues](https://github.com/saasplatform-repo/saas-platform-community/issues) |
| Website | [saasplatform.app](https://saasplatform.app) |

## License

MIT — see [LICENSE](./LICENSE).
