docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A Python library for the Docker Engine API
39 Commits 23 Branches 129 Tags 8.4 MiB
Python 99.3%
Makefile 0.5%
Dockerfile 0.1%
Shell 0.1%
Go to file
shin- e62bc3bd92 Small test fixes 2013-07-03 21:49:31 +02:00
docker Allow control over the logging done by BuilderClient 2013-06-29 02:24:24 -07:00
tests Small test fixes 2013-07-03 21:49:31 +02:00
.gitignore Added .gitignore, proper packaging, updated setup.py, cleaned up commented code 2013-05-23 06:35:51 -07:00
README.md Added README.md 2013-05-15 22:07:46 +03:00
requirements.txt Added requirements file 2013-06-06 09:05:19 -07:00
setup.py Bumped version to 0.0.5 2013-06-24 21:34:48 +02:00

README.md

docker-py

An API client for docker written in Python

API

client.Client(base_url='http://localhost:4243')
Client class. base_url refers to the protocol+hostname+port where the docker server is hosted.

  • c.build(dockerfile)
    Identical to the docker build command. dockerfile is a file-like object or a bytes collection.

  • c.commit(container, repository=None, tag=None, message=None, author=None, conf=None)
    Identical to the docker commit command.

  • c.containers(quiet=False, all=False, trunc=True, latest=False, since=None, before=None, limit=-1)
    Identical to the docker ps command.

  • c.create_container(image, command, hostname=None, user=None, detach=False, stdin_open=False, tty=False, mem_limit=0, ports=None, environment=None, dns=None, volumes=None, volumes_from=None)
    Creates a container that can then be started. Parameters are similar to those for the docker run command except it doesn't support the attach options (-a)

  • c.diff(container)
    Identical to the docker diff command.

  • c.export(container)
    Identical to the docker export command.

  • c.history(image)
    Identical to the docker history command.

  • c.images(name=None, quiet=False, all=False, viz=False)
    Identical to the docker images command.

  • c.import_image(src, repository=None, tag=None)
    Identical to the docker import command. If src is a string or unicode string, it will be treated as a URL to fetch the image from. To import an image from the local machine, src needs to be a file-like object or bytes collection.

  • c.info()
    Identical to the docker info command.

  • c.insert(url, path)
    Identical to the docker insert command.

  • c.inspect_container(container_id)
    Identical to the docker inspect command, but can only be used with a container ID.

  • c.inspect_image(container_id)
    Identical to the docker inspect command, but can only be used with an image ID.

  • c.kill(containers...)
    Identical to the docker kill command.

  • c.login(username, password=None, email=None)
    Identical to the docker login command (but non-interactive, obviously).

  • c.logs(container)
    Identical to the docker logs command.

  • c.port(container, private_port)
    Identical to the docker port command.

  • c.pull(repository, tag=None, registry=None)
    Identical to the docker pull command.

  • c.push(repository, registry=None) Identical to the docker push command.

  • c.remove_container(containers..., v=False)
    Identical to the docker rm command.

  • c.remove_image(images...)
    Identical to the docker rmi command.

  • c.restart(containers..., t=10)
    Identical to the docker restart command.

  • c.search(term)
    Identical to the docker search command.

  • c.start(container)
    Identical to the docker start command, but doesn't support attach options. Use docker logs to recover stdout/stderr

  • c.stop(containers..., t=10)
    Identical to the docker stop command.

  • c.tag(image, repository, tag=None, force=False)
    Identical to the docker tag command.

  • c.version()
    Identical to the docker version command.

  • c.wait(containers...)
    Identical to the docker wait command.