Skip to main content

atlas-local-lib-py

Python library for managing MongoDB Atlas Local deployments. It wraps the atlas-local Rust library and requires a running Docker daemon.

Requirements

  • Python >= 3.10
  • Docker running locally

Installation

pip install atlas-local-lib-py

Usage

Create a deployment

from atlas_local import LocalDeployment

deployment = LocalDeployment.create(name="my-local-deployment")

print(deployment.container_id)
print(deployment.state)

Get or create a deployment

Use get_or_create to reuse an existing deployment with matching options, or create a new one if it doesn't exist.

deployment = LocalDeployment.get_or_create(name="my-local-deployment")

Get an existing deployment

deployment = LocalDeployment.get("my-local-deployment")

List deployments

for deployment in LocalDeployment.list():
    print(deployment.name, deployment.state)

Manage the deployment lifecycle

deployment.stop()
deployment.start()
deployment.pause()
deployment.unpause()
deployment.delete()

Each lifecycle method is also available as a static method that takes a container ID or name, for example LocalDeployment.stop_deployment("my-local-deployment").

Error handling

Operations raise exceptions rooted at atlas_local.AtlasLocalError, with more specific subclasses such as CreateDeploymentError, GetDeploymentError, DeleteDeploymentError, StartDeploymentError, StopDeploymentError, PauseDeploymentError, and UnpauseDeploymentError.

from atlas_local import AtlasLocalError, LocalDeployment

try:
    deployment = LocalDeployment.get("nonexistent-deployment")
except AtlasLocalError as error:
    print(f"Failed to get deployment: {error}")

Development

Build the extension in editable mode:

pip install maturin
maturin develop --extras test

Run the test suite:

pytest

Integration tests require a running Docker daemon and are opt-in:

pytest -m integration

Metadata

Release files for atlas-local-lib-py 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for atlas-local-lib-py 1.0.0
File Size Uploaded Provenance Actions
atlas_local_lib_py-1.0.0.tar.gz 84.6 kB With provenance Details for atlas_local_lib_py-1.0.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for atlas-local-lib-py 1.0.0
File Actions
atlas_local_lib_py-1.0.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for atlas_local_lib_py-1.0.0-cp310-abi3-win_amd64.whl
atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_x86_64.whl CPython 3.10 abi3 Linux glibc 2.28+ x86-64 Details for atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_x86_64.whl
atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_aarch64.whl CPython 3.10 abi3 Linux glibc 2.28+ ARM64 Details for atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_aarch64.whl
atlas_local_lib_py-1.0.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for atlas_local_lib_py-1.0.0-cp310-abi3-macosx_11_0_arm64.whl
atlas_local_lib_py-1.0.0-cp310-abi3-macosx_10_12_x86_64.whl CPython 3.10 abi3 macOS 10.12+ x86-64 Details for atlas_local_lib_py-1.0.0-cp310-abi3-macosx_10_12_x86_64.whl

Total release size: 7.3 MB

Release files / atlas_local_lib_py-1.0.0.tar.gz

Download URL atlas_local_lib_py-1.0.0.tar.gz
Size 84.6 kB
Tags Source
SHA-256 checksum
How to use checksums
079995f4614e9bb5c6eb67b9b02e3d96e20d12362a6b05d784fb004244ca1777
BLAKE2b-256 checksum
How to use checksums
b8cae2a5e44ce68192044243acd37c6daa373645eaf82bf77cc6b4dfc0e023e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / atlas_local_lib_py-1.0.0-cp310-abi3-win_amd64.whl

Download URL atlas_local_lib_py-1.0.0-cp310-abi3-win_amd64.whl
Size 1.3 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
bd45cdc99076ba50798184ea52963ef88f36daf6c30a35346a775c9591b162b4
BLAKE2b-256 checksum
How to use checksums
e1533d49529f8e53a8efd8f0a1e7f963a96b1cd7a6c08ba8b0c22d17be231ab4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_x86_64.whl

Download URL atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_x86_64.whl
Size 1.5 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
765b06f05658bad303353dabe4846dded912c374fe45c48c87e5866cd7bb6d5f
BLAKE2b-256 checksum
How to use checksums
7efeec7662bc2f4609aca65a9e740937e44a460af7affae834820f03aaf19514
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_aarch64.whl

Download URL atlas_local_lib_py-1.0.0-cp310-abi3-manylinux_2_28_aarch64.whl
Size 1.6 MB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
a243e98d3a1bb57b92cecf53bd52a0039d82b14175d2a439ad62d5b26d031b17
BLAKE2b-256 checksum
How to use checksums
0d18653997ea90abf0cf96517720960692d891e34efbfd9fdd4639712b337f3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / atlas_local_lib_py-1.0.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL atlas_local_lib_py-1.0.0-cp310-abi3-macosx_11_0_arm64.whl
Size 1.4 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
da407f94441ca3dbfc1cc10643d2a4f0f69c8744f409f17fe3cca6ee6572a705
BLAKE2b-256 checksum
How to use checksums
20d217b8ad8414c9febd0d6c82dc382a8513b050b8a35050e6f54b086489362f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / atlas_local_lib_py-1.0.0-cp310-abi3-macosx_10_12_x86_64.whl

Download URL atlas_local_lib_py-1.0.0-cp310-abi3-macosx_10_12_x86_64.whl
Size 1.4 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
76e6c5327cb1e213d5ffea0cc0933f6a47104fffa9d300e0d136fde8c7988ce6
BLAKE2b-256 checksum
How to use checksums
902bc2c729f49c51ebae6aceb9163ed0ec62eaa37cec805c0359516535d2f904
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Security for atlas-local-lib-py 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for atlas_local_lib_py-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page