A simple Docker HTTP API wrapper written with asyncio and aiohttp.
Project description
A simple Docker HTTP API wrapper written with asyncio and aiohttp.
Installation
pip install aiodocker
Development
Create a virtualenv (either using python -m venv, pyenv or your favorite tools) and install in the editable mode with ci and dev optional dependency sets.
pip install -U pip
pip install -e '.[ci,dev]' # in zsh, you need to escape brackets
pre-commit install
Running tests
# Run all tests
make test
# Run individual tests
python -m pytest tests/test_images.py
Building packages
NOTE: Usually you don’t need to run this step by yourself.
pip install -U build
python -m build --sdist --wheel
Documentation
Examples
import asyncio
import aiodocker
async def list_things(docker):
print('== Images ==')
for image in (await docker.images.list()):
tags = image['RepoTags'][0] if image['RepoTags'] else ''
print(image['Id'], tags)
print('== Containers ==')
for container in (await docker.containers.list()):
print(f" {container._id}")
async def run_container(docker):
print('== Running a hello-world container ==')
container = await docker.containers.create_or_replace(
config={
'Cmd': ['/bin/ash', '-c', 'echo "hello world"'],
'Image': 'alpine:latest',
},
name='testing',
)
await container.start()
logs = await container.log(stdout=True)
print(''.join(logs))
await container.delete(force=True)
async def main():
docker = aiodocker.Docker()
await list_things(docker)
await run_container(docker)
await docker.close()
if __name__ == "__main__":
asyncio.run(main())
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
aiodocker-0.23.0.tar.gz
(135.2 kB
view details)
Built Distribution
File details
Details for the file aiodocker-0.23.0.tar.gz
.
File metadata
- Download URL: aiodocker-0.23.0.tar.gz
- Upload date:
- Size: 135.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45ede291063c7d1c24e78a766013c25e85b354a3bdcca68fe2bca64348e4dee2 |
|
MD5 | 867a945c7806c879cee5e19605b99a02 |
|
BLAKE2b-256 | 78cbc0fa4944604a182db4c062fea84fbdd77d2e508932dd0052ec784040ac13 |
Provenance
File details
Details for the file aiodocker-0.23.0-py3-none-any.whl
.
File metadata
- Download URL: aiodocker-0.23.0-py3-none-any.whl
- Upload date:
- Size: 34.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c7ff2fc9e557898ae77bc9c1af8916f269285f230aedf1abbb81436054baed4 |
|
MD5 | 2500ce7ca2e721cf7bd812f486d4bb63 |
|
BLAKE2b-256 | f9dc7a34f2a50fef8a3e7e02618b8fec516fa29a91d2fe264ab49514f9affc82 |