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

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for daveankin from gravatar.com daveankin Avatar for kiview from gravatar.com kiview Avatar for SergeyPirogov from gravatar.com SergeyPirogov Avatar for tillahoffmann from gravatar.com tillahoffmann Avatar for totallyzen from gravatar.com totallyzen

Unverified details

These details have not been verified by PyPI
Meta
  • License: Apache Software License
  • Author: Sergey Pirogov
  • Maintainer: Balint Bartha
  • Tags testing, logging, docker, test automation
  • Requires: Python <4.0, >=3.9
  • Provides-Extra: arangodb, aws, azurite, cassandra, chroma, clickhouse, cockroachdb, cosmosdb, db2, elasticsearch, generic, google, influxdb, k3s, kafka, keycloak, localstack, mailpit, memcached, milvus, minio, mongodb, mqtt, mssql, mysql, nats, neo4j, nginx, ollama, opensearch, oracle, oracle-free, postgres, qdrant, rabbitmq, redis, registry, scylla, selenium, sftp, test-module-import, trino, vault, weaviate
Classifiers

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

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

Supported by

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