Skip to main content

Official Python SDK for SaaS Platform API

Project description

saasplatform-sdk

Official Python client for SaaS Platform — OpenAPI-generated access to workspace APIs with JWT and API key authentication.

Current release: saasplatform-sdk@1.0.1 on PyPI.

Installation

pip install saasplatform-sdk

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

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

Quick start

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:

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
Issues github.com/saasplatform-repo/saas-platform-community/issues
Website saasplatform.app

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

saasplatform_sdk-1.0.1.tar.gz (133.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

saasplatform_sdk-1.0.1-py3-none-any.whl (255.1 kB view details)

Uploaded Python 3

File details

Details for the file saasplatform_sdk-1.0.1.tar.gz.

File metadata

  • Download URL: saasplatform_sdk-1.0.1.tar.gz
  • Upload date:
  • Size: 133.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for saasplatform_sdk-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c35907126975a061b0d0c3c6eb194492c62f0b2ffb48510f6aeac5ed55c7982d
MD5 c237265e8b766dc81561ae863722ac33
BLAKE2b-256 4c576c550cc2df4f84dc507db9f4d7efbd8defe5b9467b958917d0c5bdaff42b

See more details on using hashes here.

File details

Details for the file saasplatform_sdk-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for saasplatform_sdk-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 966b4770852d4b1e9d02d119eee77d55b440374eedc4138756239e760f899d5d
MD5 4605338d3d9dad3c2193959ca76ac90d
BLAKE2b-256 b456c01ea4c8b92c963b964c4f736258e4e5b57e0abdfb2cc1c81241e44a1ded

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page