Skip to main content

Official Python SDK for the smplkit platform

Project description

smplkit Python SDK

The official Python SDK for smplkit — simple application infrastructure that just works.

Installation

pip install smplkit-sdk

Requirements

  • Python 3.10+

Quick Start

from smplkit import SmplClient

# Option 1: Explicit API key
client = SmplClient(api_key="sk_api_...")

# Option 2: Environment variable (SMPLKIT_API_KEY)
# export SMPLKIT_API_KEY=sk_api_...
client = SmplClient()

# Option 3: Configuration file (~/.smplkit)
# [default]
# api_key = "sk_api_..."
client = SmplClient()
from smplkit import SmplClient

with SmplClient(api_key="sk_api_...") as client:
    # Get a config by key
    config = client.config.get(key="user_service")

    # List all configs
    configs = client.config.list()

    # Create a config
    new_config = client.config.create(
        name="My Service",
        key="my_service",
        description="Configuration for my service",
        values={"timeout": 30, "retries": 3},
    )

    # Delete a config
    client.config.delete(new_config.id)

For async usage:

from smplkit import AsyncSmplClient

async with AsyncSmplClient(api_key="sk_api_...") as client:
    config = await client.config.get(key="user_service")

Configuration

The API key is resolved using the following priority:

  1. Explicit argument: Pass api_key directly to the constructor.
  2. Environment variable: Set SMPLKIT_API_KEY.
  3. Configuration file: Add api_key under [default] in ~/.smplkit (TOML format):
[default]
api_key = "sk_api_..."

If none of these are set, the SDK raises SmplError with a message listing all three methods.

Error Handling

All SDK errors extend SmplError:

from smplkit import SmplError, SmplNotFoundError

try:
    config = client.config.get(key="nonexistent")
except SmplNotFoundError:
    print("Config not found")
except SmplError as e:
    print(f"SDK error: {e}")
Exception Cause
SmplNotFoundError Resource not found
SmplConflictError Conflict (e.g., has children)
SmplValidationError Validation error
SmplTimeoutError Request timed out
SmplConnectionError Network connectivity issue
SmplError Any other SDK error

Documentation

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

smplkit_sdk-2.1.11.tar.gz (94.2 kB view details)

Uploaded Source

Built Distribution

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

smplkit_sdk-2.1.11-py3-none-any.whl (182.4 kB view details)

Uploaded Python 3

File details

Details for the file smplkit_sdk-2.1.11.tar.gz.

File metadata

  • Download URL: smplkit_sdk-2.1.11.tar.gz
  • Upload date:
  • Size: 94.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for smplkit_sdk-2.1.11.tar.gz
Algorithm Hash digest
SHA256 26f81edf3af8b9d732cb9559c44c348f1a3c26205d689d8a1efe9edefbcbfda1
MD5 01fa78cac207a4a25f4150bad9e48edb
BLAKE2b-256 f29bd0bf9c2ada4417c40e650e96227b30e98ec25a17a7ed54024d341c4fc16b

See more details on using hashes here.

Provenance

The following attestation bundles were made for smplkit_sdk-2.1.11.tar.gz:

Publisher: ci-cd.yml on smplkit/python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file smplkit_sdk-2.1.11-py3-none-any.whl.

File metadata

  • Download URL: smplkit_sdk-2.1.11-py3-none-any.whl
  • Upload date:
  • Size: 182.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for smplkit_sdk-2.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1b8a54110ebbe261bb8dd21b7f49bb1a3ba1ba21584d25cdf2817e1c1a10a982
MD5 c0d03de79f490f00b483e2f8023c3bea
BLAKE2b-256 c4b3ef68a4fafe885fdf3928d0ebf708c4a2e91e1358eec30f9abe0463d9e39f

See more details on using hashes here.

Provenance

The following attestation bundles were made for smplkit_sdk-2.1.11-py3-none-any.whl:

Publisher: ci-cd.yml on smplkit/python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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