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:
    # --- Runtime: resolve config values ---
    # Connect and read resolved key/value pairs for your service
    db = client.config.get("database")  # {"host": "...", "port": 5432}

    # --- Management: CRUD operations ---
    # List all configs
    configs = client.config.management.list()

    # Create a new config
    cfg = client.config.management.new("my_service", name="My Service")
    cfg.save()

    # Get a config by id
    cfg = client.config.management.get("my_service")

    # Delete a config
    client.config.management.delete("my_service")

    # --- Flags management ---
    flag = client.flags.management.newBooleanFlag("checkout-v2", default=False)
    flag.save()
    flags = client.flags.management.list()

    # --- Logging management ---
    logger = client.logging.management.new("sql", name="SQL Logger")
    logger.save()

For async usage:

from smplkit import AsyncSmplClient

async with AsyncSmplClient(api_key="sk_api_...") as client:
    # Runtime
    db = await client.config.get("database")

    # Management
    cfg = await client.config.management.get("my_service")
    configs = await client.config.management.list()

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.management.get("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.51.tar.gz (205.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.51-py3-none-any.whl (343.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smplkit_sdk-2.4.51.tar.gz
  • Upload date:
  • Size: 205.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.51.tar.gz
Algorithm Hash digest
SHA256 1d63e52a06a5837503d1c075ceb8c3402d8ea7409962cc9743708c836cedc553
MD5 6ff9febebc1bb5cf0b73d95740533fbe
BLAKE2b-256 6ee7bd2f8056054ed55f7c1719b34b1e2f0dfe5939e196102058a084e2cad10d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: smplkit_sdk-2.4.51-py3-none-any.whl
  • Upload date:
  • Size: 343.4 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.51-py3-none-any.whl
Algorithm Hash digest
SHA256 60a42f559848eea02b9adc575ad273a51528270141558fa617a23bf00bb663b1
MD5 98f9391a19a31a018e82d3554e21b080
BLAKE2b-256 000fcff66bf1b72b2043ad19a125431180187daadff909fe4fc9099dee70dc8d

See more details on using hashes here.

Provenance

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