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 (Apache-2.0)
  • Author: Sergey Pirogov
  • Maintainer: Balint Bartha
  • Tags testing , logging , docker , test automation
  • Requires: Python <4.0, >=3.9.2
  • 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 , openfga , opensearch , oracle , oracle-free , postgres , qdrant , rabbitmq , redis , registry , scylla , selenium , sftp , test-module-import , trino , vault , weaviate
Classifiers
Report project as malware

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

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 (Apache-2.0)
  • Author: Sergey Pirogov
  • Maintainer: Balint Bartha
  • Tags testing , logging , docker , test automation
  • Requires: Python <4.0, >=3.9.2
  • 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 , openfga , opensearch , oracle , oracle-free , postgres , qdrant , rabbitmq , redis , registry , scylla , selenium , sftp , test-module-import , trino , vault , weaviate
Classifiers

Release history Release notifications | RSS feed

This version

4.13.2

4.13.1

4.13.0

4.12.0

4.11.0 yanked

Reason this release was yanked:

broken - this is the quickest fix

4.10.0

4.9.2

4.9.1

4.9.0

4.8.2

4.8.1

4.8.0

4.7.2

4.7.1

4.7.0

4.6.0

4.5.1

4.5.0

4.4.1

4.4.0

4.3.3

4.3.2

4.3.1

4.3.1rc1 pre-release

4.3.0

4.2.0

4.2.0rc2 pre-release

4.2.0rc1 pre-release

4.1.2

4.1.1

4.1.0 yanked

Reason this release was yanked:

tried to replace - cant replace, can only yank

4.0.1

4.0.0

4.0.0rc2 pre-release

4.0.0rc1 pre-release

3.7.1

3.7.0

3.6.1

3.6.0

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.2

3.4.1

3.4.0

3.3.0

3.2.0

3.1.0

3.0.3

3.0.2

3.0.0

2.6.0

2.5

2.3

2.2

2.1.2

2.1.0

2.0.0

1.0.2

1.0.1

1.0

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.2.tar.gz (78.7 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.2-py3-none-any.whl (124.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: testcontainers-4.13.2.tar.gz
  • Upload date:
  • Size: 78.7 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.2.tar.gz
Algorithm Hash digest
SHA256 2315f1e21b059427a9d11e8921f85fef322fbe0d50749bcca4eaa11271708ba4
MD5 ff954b12122b810863eef8a7e7c135b9
BLAKE2b-256 1851edac83edab339d8b4dce9a7b659163afb1ea7e011bfed1d5573d495a4485

See more details on using hashes here.

Provenance

The following attestation bundles were made for testcontainers-4.13.2.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.2-py3-none-any.whl.

File metadata

File hashes

Hashes for testcontainers-4.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0209baf8f4274b568cde95bef2cadf7b1d33b375321f793790462e235cd684ee
MD5 cae089dae9ccd0a4b5d220642ec860f8
BLAKE2b-256 2a5e73aa94770f1df0595364aed526f31d54440db5492911e2857318ed326e51

See more details on using hashes here.

Provenance

The following attestation bundles were made for testcontainers-4.13.2-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

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