Skip to main content

A simple Docker HTTP API wrapper written with asyncio and aiohttp.

Project description

PyPI version Python Versions GitHub Actions status for the main branch Code Coverage Chat on Gitter

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

http://aiodocker.readthedocs.io

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


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.22.1.tar.gz (134.7 kB view details)

Uploaded Source

Built Distribution

aiodocker-0.22.1-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file aiodocker-0.22.1.tar.gz.

File metadata

  • Download URL: aiodocker-0.22.1.tar.gz
  • Upload date:
  • Size: 134.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for aiodocker-0.22.1.tar.gz
Algorithm Hash digest
SHA256 fb969fdf2ac574d800ddf132940e0337fe459e191b8024ef66ec8328effa63ce
MD5 c71cf9b5e8826cc088ccf0209a76326d
BLAKE2b-256 555e9e61e7604ac586c9f0b0fa7f8b6a0c25e8b15c9478ca55969cc43f258167

See more details on using hashes here.

Provenance

File details

Details for the file aiodocker-0.22.1-py3-none-any.whl.

File metadata

  • Download URL: aiodocker-0.22.1-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for aiodocker-0.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e42d6e6cbf8f2afb431b77208be0f7e81d07eb38c8176f18d58761115b2acf5
MD5 7ae7b380664a539ec59ba11e7b6a0dd4
BLAKE2b-256 55f648a88b2aaf6a3ecade21467770f17bca5716b7cb5446e8d41bde6d300a4a

See more details on using hashes here.

Provenance

Supported by

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