An API client for docker written in Python
To instantiate a Client class that will allow you to communicate with
a Docker daemon, simply do:
c=docker.Client(base_url='unix://var/run/docker.sock',
version='1.6',
timeout=10)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 and
timeout specifies the HTTP request timeout, in seconds.
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=None, 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, name=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). See "Port bindings" and "Using volumes" below for
more information on how to create port bindings and volume mappings.
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, signal=None)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, stdout=True, stderr=True, stream=False)Identical to the docker logs command. The stream parameter makes the
logs function return a blocking generator you can iterate over to
retrieve log output as it happens.
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)
```
Removeacontainer. Similartothe`docker rm`command.
```pythonc.remove_image(image)
```
Removeanimage. Similartothe`docker rmi`command.
```pythonc.restart(container, timeout=10)
```Restart a container. Similar to the `dockerrestart` command.
```pythonc.search(term)
```
Identicaltothe`docker search`command.
```pythonc.start(container, binds=None, port_bindings=None, lxc_conf=None,
privileged=False)
```
Similartothe`docker start`command, butdoesn'tsupportattachoptions. Use`docker logs`torecover`stdout`/`stderr`.
`binds`allowstobindadirectoryinthehosttothecontainer. See"Using volumes"belowformoreinformation. `port_bindings`exposescontainerportstothehost. See"Port bindings"belowformoreinformation. `lxc_conf`allowstopassLXCconfigurationoptionsusingadictionary. `privileged`startsthecontainerinprivilegedmode.
```pythonc.stop(container, timeout=10)
```
Stopsacontainer. Similartothe`docker stop`command.
```pythonc.tag(image, repository, tag=None, force=False)
```
Identicaltothe`docker tag`command.
```pythonc.top(container_id)
```
Identicaltothe`docker top`command.
```pythonc.version()
```
Identicaltothe`docker version`command.
```pythonc.wait(container)
```
Waitforacontainerandreturnitsexitcode. Similartothe `dockerwait` command.
Portbindings=============Portbindingsisdoneintwoparts. Firstly, byprovidingalistofportstoopeninsidethecontainerinthe`Client.create_container`method.
```pythonc.create_container('busybox', 'ls', ports=[1111, 2222])
```
IfyouwishtouseUDPinsteadofTCP (default), youcandeclareitlikesuch:
```pythonc.create_container('busybox', 'ls', ports=[(1111, 'udp'), 2222])
```
Bindingsarethendeclaredinthe`Client.start`method.
```pythonc.start(container_id, port_bindings={1111: 4567, 2222: None})
```
Youcanlimitthehostaddressonwhichtheportwillbeexposedlikesuch:
```pythonc.start(container_id, port_bindings={1111: ('127.0.0.1', 4567)})
```
Orwithouthostportassignment:
```pythonc.start(container_id, port_bindings={1111: ('127.0.0.1',)})
```
Usingvolumes=============Similarly, volumedeclarationisdoneintwoparts. First, youhavetoprovidealistofmountpointstothe`Client.create_container`method.
```pythonc.create_container('busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2'])
```
Volumemappingsarethendeclaredinsidethe`Client.start`methodlikethis:
```pythonc.start(container_id, bindings={
'/mnt/vol2': '/home/user1/',
'/mnt/vol1': '/var/www'
})
```