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.10.tar.gz (167.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.10-py3-none-any.whl (258.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smplkit_sdk-2.4.10.tar.gz
  • Upload date:
  • Size: 167.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.10.tar.gz
Algorithm Hash digest
SHA256 0569ab0eed81793ab151c582857c451881ba3d8034885f49e0e125f134a8fb43
MD5 bd00f80b7321ba890079ad27573d3fad
BLAKE2b-256 908f5be2bf818ceb1f123a4b194b766ecc83d860054751f4e3a02f5c9c81adf9

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: smplkit_sdk-2.4.10-py3-none-any.whl
  • Upload date:
  • Size: 258.8 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a544c2291ce08e46d64282300d2dfefd2d7c0bd5ed09880e9ed67628e1bb4eb0
MD5 cf4be9cd5110502a91e721ca0f22c759
BLAKE2b-256 b6925c7851cc169f951d8e00e382d8e6d4919a4f191283181d6bd1622d8eec06

See more details on using hashes here.

Provenance

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