Skip to main content

Autonoma SDK — automate the Autonoma Environment Factory endpoint

Project description

Autonoma Python SDK

Python implementation of the Autonoma Environment Factory SDK.

Package

Package Description
autonoma-ai Core protocol (HMAC, refs, graph, handler)
autonoma-ai[sqlalchemy] SQLAlchemy executor adapter
autonoma-ai[django] Django executor adapter and server handler
autonoma-ai[flask] Flask server adapter
autonoma-ai[fastapi] FastAPI server adapter
autonoma-ai[postgres] PostgreSQL driver (psycopg2)
autonoma-ai[all] All adapters and drivers

Quick Start

Install

pip install autonoma-ai
# With extras:
pip install "autonoma-ai[sqlalchemy,fastapi,postgres]"
# Or everything:
pip install "autonoma-ai[all]"

FastAPI + SQLAlchemy

from autonoma.types import HandlerConfig
from autonoma_fastapi import create_fastapi_handler
from autonoma_sqlalchemy import sqlalchemy_executor
from sqlalchemy import create_engine

engine = create_engine("postgresql://user:pass@localhost/mydb")

config = HandlerConfig(
    executor=sqlalchemy_executor(engine),
    scope_field="organization_id",
    shared_secret="your-shared-secret",
    signing_secret="your-signing-secret",
    auth=lambda user, context: {
        "headers": {"Authorization": f"Bearer {create_session_token(user['id'])}"}
    },
)

router = create_fastapi_handler(config)
app.include_router(router, prefix="/api/autonoma")

Model name ↔ table name

By default, the SDK derives a model name from each SQL table by splitting on _ and PascalCasing each part — no pluralization. Examples:

SQL table Auto-derived model name
user User
api_key ApiKey
branch_deployment BranchDeployment
organizations Organizations (stays plural)
api_keys ApiKeys (stays plural)

If every factory you register is keyed under the auto-derived name, omit table_name_map entirely. The SDK handles the mapping.

You only need table_name_map when a factory key disagrees with the auto-derived name. Common reasons:

  • Your tables are plural but you want singular factory keys: organizations table ↔ Organization key.
  • Legacy short names: usr table ↔ User key, acl table ↔ AccessControl key.

The map is sparse, not exhaustive: only list entries that actually differ. Auto-derivation covers the rest.

# Tables in DB: organization, user, api_key, deal   (singular)
# Factories keyed: Organization, User, ApiKey, Deal
# table_name_map = None  # auto-derive is exact; omit the kwarg

# Tables in DB: organizations, users, api_keys
# Factories keyed singular → every entry disagrees:
config = HandlerConfig(
    ...,
    table_name_map={
        "Organization": "organizations",
        "User": "users",
        "ApiKey": "api_keys",
    },
    factories={"Organization": ..., "User": ..., "ApiKey": ...},
)

Red flag: if your table_name_map has one entry per factory and every entry is just a plural↔singular rename, consider keeping factory keys plural (Organizations) and dropping the map entirely. Plural keys are valid — pick whichever convention your scenarios use.

Commands

poetry install --all-extras   # install with all adapters
poetry run pytest              # run tests
poetry run pytest -k "sqlalchemy"  # tests matching pattern

Documentation

For protocol-level documentation, see the root protocol/ directory. For runnable examples, see examples/python/.

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

autonoma_ai-0.2.0.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autonoma_ai-0.2.0-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file autonoma_ai-0.2.0.tar.gz.

File metadata

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

File hashes

Hashes for autonoma_ai-0.2.0.tar.gz
Algorithm Hash digest
SHA256 42c22746bdb2064871ce4c41c7b58b60e8c9fdb4220b578d19eec2c7d901d2b4
MD5 86d5ae87895f8a82aa1694a6193f0030
BLAKE2b-256 9dc344b1d86069e0449b113971bd1f33268ae381e11895b06306883bbee0ae7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for autonoma_ai-0.2.0.tar.gz:

Publisher: publish.yml on Autonoma-AI/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 autonoma_ai-0.2.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for autonoma_ai-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c456084451c8e90e2ea4dbcd4f34767a0b2ccb17bb5437674d02a2fed869942b
MD5 f8950924171d96d92ca734ce54406e72
BLAKE2b-256 a6015e8df9dfe76983299551efef0663d2c59b93a91bc1716609c20ee66a6d68

See more details on using hashes here.

Provenance

The following attestation bundles were made for autonoma_ai-0.2.0-py3-none-any.whl:

Publisher: publish.yml on Autonoma-AI/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