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.
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 |
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.8.0.tar.gz
(63.6 kB
view hashes)
Built Distribution
testcontainers-4.8.0-py3-none-any.whl
(104.3 kB
view hashes)
Close
Hashes for testcontainers-4.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b85d787e5b1f8b32042704d23b6c54787bf6751d2d3cfee2c031349ef2eea30 |
|
MD5 | e7c253c5d8fc970e75399407c8e1b7d0 |
|
BLAKE2b-256 | 7870059beaf0f999be798764c2ef423b3cc2a3846a984f85d081a1ab00cd235f |