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.27.tar.gz (181.7 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.27-py3-none-any.whl (291.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smplkit_sdk-2.4.27.tar.gz
  • Upload date:
  • Size: 181.7 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.27.tar.gz
Algorithm Hash digest
SHA256 1985b98965ed52e960ab2239b9664396e43a2abe10cf2f838dfdd66231d0765c
MD5 391d907ad233e3450ec4bb34ba804fab
BLAKE2b-256 5e29fc98801a665a3fb04a17d2728fb350e094b79056025e6c9c8dba6fae2e75

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: smplkit_sdk-2.4.27-py3-none-any.whl
  • Upload date:
  • Size: 291.1 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.27-py3-none-any.whl
Algorithm Hash digest
SHA256 d6e8ee670563ddfcdd864b8b781ab869943d75e40de84f6220260fa8f1aa54ff
MD5 a8e63d5c21540b8e79652b4de5beb67b
BLAKE2b-256 944616bb7678fe09169c1f1883a2256dd9f634ab0b732304bf2545f9384590b6

See more details on using hashes here.

Provenance

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