Python library for throwaway instances of anything that can run in a Docker container
Project description
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.
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.7.0 |
Custom image for ryuk |
RYUK_RECONNECTION_TIMEOUT |
10s |
Reconnection timeout for Ryuk TCP socket before Ryuk reaps all dangling containers |
Project details
Release history Release notifications | RSS feed
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.5.0.tar.gz
(44.4 kB
view hashes)
Built Distribution
Close
Hashes for testcontainers-4.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6833df7db4cf8403feb1e4daf69b02a091d9da37aa3e8e808c756abbddb41cf3 |
|
MD5 | 289548ab39b872470e7dd9f7c3f5d807 |
|
BLAKE2b-256 | d042aa5e5360322368860ff13b3f390d7ef47d89f77d5520f7a46b2a35558721 |