Skip to main content

License: MIT made-with-python Open Source? Yes! PyTest

docker-lite-python

A simple, Python-based Docker interface built on top of the Docker SDK for Python. Intended to programmatically spin up, pass communications to, and ultimately tear down single Docker containers. Requires a local instance of Docker.

Installation | Quick Start | Reference | Examples

Installation:

pip install docker-lite-python

Quick Start:

$ sudo python3
>>>from docker_light_python import DockerLite
>>>dl = DockerLite()

start an Alpine container and keep it running

>>>dl.run_container('alpine:latest', 'alpine-container', 'sleep infinity')

exec into the running container

>>>dl.exec_into_running_container('alpine-container', 'echo "Hello World!"')
ExecResult(exit_code=0, output=b'Hello World!\n')

tear down that container!

>>>dl.kill_container('alpine-container')
0

Reference:

Methods Args Overview
build_image() *path_to_dir*: string: The path to the build directory. Build a Docker image from a local Dockerfile.
*resulting_image_name*: string Enforces best practice of explicitly naming images.
list_containers() *all*: bool: default=False List running containers by default.
run_container() *image_name*: string Run a Docker container, optionally with a command.
*resulting_container_name*: string Enforces best practice of explicitly naming containers.
*command*: string: The command to run. Optional.
get_container_by_name() *existing_container_name*: string Get a Docker container by name.
exec_into_running_container() *existing_container_name*: string Run a command in an active container.
*command*: string: The command to execute in the running Docker container.
list_images() None List all images in the local Docker instance.
remove_unused_images() None Equivalent of docker images prune
remove_all_images() None Force removal of all images. Purge system.
kill_container() *existing_container_name*: string Shut down and delete a container.
NOTE: kill_container() technically just stops the containers, as they are self-removing.

Examples:

from docker_lite import DockerLite

dl = DockerLite()

build image, 'my-image,' from a Dockerfile in the local directory

dl.build_image('./', 'my-image')

list all containers. Default is to list running containers

containers = dl.list_containers(all=True)

run a Docker container called 'my-container' based on a Docker image called 'my-image'

my_container = dl.run_container('my-image', 'my-container')

run a terminal command in a running Docker container called 'my-container'. Be creative

output = dl.exec_into_running_container('my-container', 'echo "Hello World!"')

get a container called 'my-container' by its unique name

container = dl.get_container('my-container')

kill a container called 'my-container' by its unique name

dl.kill_container('my-container')

Metadata

Release files for docker-lite-python 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docker-lite-python 1.0.6
File Size Uploaded Provenance Actions
docker-lite-python-1.0.6.tar.gz 4.0 kB Without provenance Details for docker-lite-python-1.0.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for docker-lite-python 1.0.6
File Interpreter ABI Platform Actions
docker_lite_python-1.0.6-py3-none-any.whl Python 3 none any Details for docker_lite_python-1.0.6-py3-none-any.whl

Total release size: 9.3 kB

Release files / docker-lite-python-1.0.6.tar.gz

Download URL docker-lite-python-1.0.6.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1d67b7b5f109399c5b1d8b1283f653230c267c2c7309cdc93b9634bf62443d78
BLAKE2b-256 checksum
How to use checksums
8dffe38d0648bd26c62a6dedf13d8004b9347793d1863b17b095a3dfd19ab45b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3

Release files / docker_lite_python-1.0.6-py3-none-any.whl

Download URL docker_lite_python-1.0.6-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5d77d86d72dc0cf69a696ddc07059a52d7bd63fc7937665ce0447cfadd8ff044
BLAKE2b-256 checksum
How to use checksums
f8d8c63a77c30b51395b7f49ee9e2a86e9db4ad61bdd5a31f4dfc00a76de5f8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3

Security for docker-lite-python 1.0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page