Skip to main content

Official Python SDK for the smplkit platform

Project description

smplkit Python SDK

PyPI Version Build Coverage License Docs

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:
# ~/.smplkit

[default]
api_key = sk_api_your_key_here

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.4.30.tar.gz (182.1 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.4.30-py3-none-any.whl (291.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for smplkit_sdk-2.4.30.tar.gz
Algorithm Hash digest
SHA256 61aff33730fc6ab54497a18bc4fc45ad6905edc771053d90b38074c0d0a800a5
MD5 40c7928dd743a1d483eb9a9f62704c8b
BLAKE2b-256 d01f5f14780190667cabbefd0c8a915e211dd3d9f7425f69937c2156060237cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for smplkit_sdk-2.4.30.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.4.30-py3-none-any.whl.

File metadata

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

File hashes

Hashes for smplkit_sdk-2.4.30-py3-none-any.whl
Algorithm Hash digest
SHA256 0532c3cab814c283d69e517d5f5d5c63d5a74c7c23836a993ee3885c4678bc5f
MD5 e0506bc00268440c754a9087db59e002
BLAKE2b-256 ef704ae18cf9fee11cb1acd5c11dc299024ee1304b00e3cfb67e9592f02ab55d

See more details on using hashes here.

Provenance

The following attestation bundles were made for smplkit_sdk-2.4.30-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