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.17.tar.gz (173.0 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.17-py3-none-any.whl (262.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smplkit_sdk-2.4.17.tar.gz
  • Upload date:
  • Size: 173.0 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.17.tar.gz
Algorithm Hash digest
SHA256 e5fb061f8ffc0ec88f36563cdeea7379bf6c90967afd8d2dbd29f6a90e76ad21
MD5 ec107eb388285f34e0a99a84c0fc6d46
BLAKE2b-256 999ecd4f05c0223d475ddd9ef84296739bd256d5c881bace91c7d68e591d29af

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: smplkit_sdk-2.4.17-py3-none-any.whl
  • Upload date:
  • Size: 262.9 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 eaeba625a29de31fb9968a21038a6f476f890bb5a4d7f502cf386ba57f5e4128
MD5 b28774ba262282a550e488a2aff4fc18
BLAKE2b-256 541c30938aa9fc4542a6bc2fcd0d0b2fdd853424edf168d32500b723b7ec04ea

See more details on using hashes here.

Provenance

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