Skip to main content

Python library for throwaway instances of anything that can run in a Docker container

Project description

Poetry Ruff PyPI - Version PyPI - License PyPI - Python Version codecov Core Tests Community Tests Docs

Codespace

Testcontainers Python

testcontainers-python facilitates the use of Docker containers for functional and integration testing.

For more information, see the docs.

Getting Started

>>> from testcontainers.postgres import PostgresContainer
>>> import sqlalchemy

>>> with PostgresContainer("postgres:16") as postgres:
...     engine = sqlalchemy.create_engine(postgres.get_connection_url())
...     with engine.begin() as connection:
...         result = connection.execute(sqlalchemy.text("select version()"))
...         version, = result.fetchone()
>>> version
'PostgreSQL 16...'

The snippet above will spin up a postgres database in a container. The get_connection_url() convenience method returns a sqlalchemy compatible url we use to connect to the database and retrieve the database version.

Contributing / Development / Release

See CONTRIBUTING.md for more details.

Configuration

You can set environment variables to configure the library behaviour:

Env Variable Example Description
TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE /var/run/docker.sock Path to Docker's socket used by ryuk
TESTCONTAINERS_RYUK_PRIVILEGED false Run ryuk as a privileged container
TESTCONTAINERS_RYUK_DISABLED false Disable ryuk
RYUK_CONTAINER_IMAGE testcontainers/ryuk:0.8.1 Custom image for ryuk
RYUK_RECONNECTION_TIMEOUT 10s Reconnection timeout for Ryuk TCP socket before Ryuk reaps all dangling containers

Alternatively you can set the configuration during runtime:

from testcontainers.core import testcontainers_config

testcontainers_config.ryuk_docker_socket = "/home/user/docker.sock"

Project details


Download files

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

Source Distribution

testcontainers-4.13.3.tar.gz (79.1 kB view details)

Uploaded Source

Built Distribution

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

testcontainers-4.13.3-py3-none-any.whl (124.8 kB view details)

Uploaded Python 3

File details

Details for the file testcontainers-4.13.3.tar.gz.

File metadata

  • Download URL: testcontainers-4.13.3.tar.gz
  • Upload date:
  • Size: 79.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for testcontainers-4.13.3.tar.gz
Algorithm Hash digest
SHA256 9d82a7052c9a53c58b69e1dc31da8e7a715e8b3ec1c4df5027561b47e2efe646
MD5 f4893fc2e2bbd80ee89920aa5e57120a
BLAKE2b-256 fcb3c272537f3ea2f312555efeb86398cc382cd07b740d5f3c730918c36e64e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for testcontainers-4.13.3.tar.gz:

Publisher: release-please.yml on testcontainers/testcontainers-python

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

File details

Details for the file testcontainers-4.13.3-py3-none-any.whl.

File metadata

  • Download URL: testcontainers-4.13.3-py3-none-any.whl
  • Upload date:
  • Size: 124.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for testcontainers-4.13.3-py3-none-any.whl
Algorithm Hash digest
SHA256 063278c4805ffa6dd85e56648a9da3036939e6c0ac1001e851c9276b19b05970
MD5 6532556c5416a3699190a90934b4fd83
BLAKE2b-256 7327c2f24b19dafa197c514abe70eda69bc031c5152c6b1f1e5b20099e2ceedd

See more details on using hashes here.

Provenance

The following attestation bundles were made for testcontainers-4.13.3-py3-none-any.whl:

Publisher: release-please.yml on testcontainers/testcontainers-python

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

Supported by

Image AWS Cloud computing and Security Sponsor Image Datadog Monitoring Image Depot Continuous Integration Image Fastly CDN Image Google Download Analytics Image Pingdom Monitoring Image Sentry Error logging Image StatusPage Status page