Skip to main content

Docker API client for asyncio

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

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.0a1.tar.gz (132.7 kB view details)

Uploaded Source

Built Distribution

aiodocker-0.22.0a1-py3-none-any.whl (32.8 kB view details)

Uploaded Python 3

File details

Details for the file aiodocker-0.22.0a1.tar.gz.

File metadata

  • Download URL: aiodocker-0.22.0a1.tar.gz
  • Upload date:
  • Size: 132.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for aiodocker-0.22.0a1.tar.gz
Algorithm Hash digest
SHA256 99defd99a009ee62fc9dff5e0fa00c9f75cea9c4f601475f52c358a17b470d78
MD5 676c14315ad6d9b34dcd9c6b15ec275a
BLAKE2b-256 ff3df76f0c69d6d6ce08df8f1dc1b960e062097e906b768eadbba99dd02dcc19

See more details on using hashes here.

File details

Details for the file aiodocker-0.22.0a1-py3-none-any.whl.

File metadata

  • Download URL: aiodocker-0.22.0a1-py3-none-any.whl
  • Upload date:
  • Size: 32.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for aiodocker-0.22.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 5c3ff9e322b3966e64fcd594d5b894e1b8b70a0a88f213ee506cff5bc4261c69
MD5 46cb12ac28983bd91760dd7359a10ee7
BLAKE2b-256 a0b2b9efe1bcedd22e9db8989a04d542ef6cd67297908d4b53bb28eb4f5c668d

See more details on using hashes here.

Supported by

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