Skip to main content

Atlas Python SDK

The first public SDK surface is intentionally small:

import atlas_sdk

atlas_sdk.configure(api_url="http://localhost:8000")

managed = atlas_sdk.conn.quack()
direct = atlas_sdk.conn.duck()

crawl = await atlas_sdk.crawls.run(
    "https://example.com/",
    depth=0,
    max_crawls=1,
)
await crawl.completed()
crawl.raise_for_status()
await crawl.materialized()

The PyPI distribution is named atlas-python-sdk; its Python import package is atlas_sdk. This keeps it safe to install alongside the Atlas backend, whose import package is atlas.

quack() and duck() return ordinary duckdb.DuckDBPyConnection instances. quack() uses the managed DuckBasin/Quack connection boundary; duck() is the development-only direct DuckLake attachment boundary.

Lifecycle waits are local, cancellable polling operations. Timing out or cancelling a wait never cancels the server-side crawl; call crawl.cancel() explicitly for that transition. materialized() waits for the ingestion writes belonging to that crawl and for the fixed document and visit projections to acknowledge those exact DuckLake snapshots.

Install the released package from PyPI:

python -m pip install atlas-python-sdk

For local development, install directly from the repository:

python -m pip install ./packages/atlas-python-sdk

The standalone end-to-end proof is examples/smoke.py. It uses ATLAS_API_URL, the standard DUCKBASIN_* managed connection variables, and either the direct connection variables or ATLAS_DIRECT_ENV_FILE.

Releasing

Repository CI publishes immutable releases from tags named atlas-python-sdk-v<version>. The tag must exactly match the static version in pyproject.toml; for example, version 0.1.0 is released with:

git tag atlas-python-sdk-v0.1.0
git push origin atlas-python-sdk-v0.1.0

PyPI publishing uses Trusted Publishing rather than a stored API token. The PyPI publisher must be configured for GitHub owner ekkuleivonen, repository atlas, workflow python-sdk-release.yml, and environment pypi. Protect that GitHub environment with required reviewers before the first release.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atlas_python_sdk-0.1.0.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

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

atlas_python_sdk-0.1.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file atlas_python_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: atlas_python_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for atlas_python_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 769f1c3da760445cb1fc79810c500f54dd4d58fe31f08122848d7c36b098fe1f
MD5 5a7b8d50ac94d131acf4c7627bf27e66
BLAKE2b-256 440e1e46e414953d6465a3a17d2543024b0352af771cc2516fe53412c86a30e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for atlas_python_sdk-0.1.0.tar.gz:

Publisher: python-sdk-release.yml on ekkuleivonen/atlas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file atlas_python_sdk-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for atlas_python_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a5e6c370993c53d4c5e29e72598998ef7603ffe7e27f47f3fd3ba8e3b413e5e
MD5 0bc34a09572ba001a9649b8e649154ec
BLAKE2b-256 f2b44db68ed311892f7ab5cfb41ab6b2ff9ecf0bde468942c4bccd298951bf82

See more details on using hashes here.

Provenance

The following attestation bundles were made for atlas_python_sdk-0.1.0-py3-none-any.whl:

Publisher: python-sdk-release.yml on ekkuleivonen/atlas

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 Sentry Error logging StatusPage Status page