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
176 Commits 23 Branches 129 Tags 8.4 MiB
Python 99.3%
Makefile 0.5%
Dockerfile 0.1%
Shell 0.1%
Go to file
Deni Bertovic afbfc703ca integration test fix 
make the mount point for shared.txt reside in the /tmp/ folder
because if it resides in the lib folder docker sets the owner of the
folder as root inside the container so then when the container exists
the test fails to cleanup and remove the shared.txt file, and breaks git as well.
 		2013-10-03 11:55:02 +02:00
docker python3 fixes 2013-10-03 11:55:02 +02:00
tests integration test fix 2013-10-03 11:55:02 +02:00
.gitignore Add python 3 support 2013-07-06 00:32:28 +10:00
ChangeLog.md Removed logger dependency (no warnings) + do not break push for API versions < 1.5 2013-09-30 19:57:10 +02:00
Dockerfile Added basic Dockerfile 2013-09-14 02:32:35 +02:00
LICENSE Add Apache 2.0 License 2013-08-07 11:39:59 -07:00
MANIFEST.in Fixed MANIFEST file 2013-09-27 20:10:29 +02:00
README.md Merge pull request #56 from kiorky/import_image_tarball 2013-09-30 09:04:07 -07:00
requirements.txt added mock to requirements 2013-10-03 11:51:12 +02:00
setup.py Bumped version to 0.2.1 2013-09-27 19:38:16 +02:00
tox.ini fix tox.ini file 2013-09-26 00:37:17 +02:00

README.md

docker-py

An API client for docker written in Python

API

docker.Client(base_url='unix://var/run/docker.sock', version="1.4")
Client class. base_url refers to the protocol+hostname+port where the docker server is hosted. Version is the version of the API the client will use.

  • c.build(path=None, tag=None, quiet=False, fileobj=None, nocache=False, rm=False)
    Similar to the docker build command. Either path or fileobj needs to be set. path can be a local path (to a directory containing a Dockerfile) or a remote URL. fileobj must be a readable file-like object to a Dockerfile.

  • 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.copy(container, resource)
    Identical to the docker cp 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, privileged=False)
    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. To import from a tarball use your absolute path to your tarball. To load arbitrary data as tarball use whatever you want as src and your tarball content in data.

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

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

  • c.inspect_container(container)
    Identical to the docker inspect command, but only for containers.

  • c.inspect_image(image_id)
    Identical to the docker inspect command, but only for images.

  • c.kill(container)
    Kill a container. Similar 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) Identical to the docker pull command.

  • c.push(repository)
    Identical to the docker push command.

  • c.remove_container(container, v=False)
    Remove a container. Similar to the docker rm command.

  • c.remove_image(image)
    Remove an image. Similar to the docker rmi command.

  • c.restart(container, timeout=10)
    Restart a container. Similar to the docker restart command.

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

  • c.start(container, binds=None, lxc_conf=None)
    Similar to the docker start command, but doesn't support attach options. Use docker logs to recover stdout/stderr
    binds Allows to bind a directory in the host to the container. Similar to the docker run command with option -v="/host:/mnt". Requires the container to be created with the volumes argument: c.create_container(..., volumes={'/mnt': {}})
    lxc_conf allows to pass LXC configuration options in dict form.

  • c.stop(container, timeout=10)
    Stops a container. Similar to the docker stop command.

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

  • c.top(container_id)
    Identical to the docker top command.

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

  • c.wait(container)
    Wait for a container and return its exit code. Similar to the docker wait command.