docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated function signatures in README

This commit is contained in:
Tim Nelson 2013-12-22 03:20:16 -06:00
parent 67e50b4f9f
commit 0eaafe2a9f
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -23,7 +23,7 @@ is hosted. `version` is the version of the API the client will use and
```python ```python
c.build(path=None, tag=None, quiet=False, fileobj=None, nocache=False, c.build(path=None, tag=None, quiet=False, fileobj=None, nocache=False,
rm=False) rm=False, stream=False)
``` ```
Similar to the `docker build` command. Either `path` or `fileobj` needs Similar to the `docker build` command. Either `path` or `fileobj` needs
@ -88,7 +88,7 @@ c.images(name=None, quiet=False, all=False, viz=False)
Identical to the `docker images` command. Identical to the `docker images` command.
```python ```python
c.import_image(src, repository=None, tag=None) c.import_image(src, data=None, repository=None, tag=None)
``` ```
Identical to the `docker import` command. If `src` is a string or Identical to the `docker import` command. If `src` is a string or
@ -105,7 +105,7 @@ c.info()
Identical to the `docker info` command. Identical to the `docker info` command.
```python ```python
c.insert(url, path) c.insert(image, url, path)
``` ```
Identical to the `docker insert` command. Identical to the `docker insert` command.
@ -129,7 +129,7 @@ c.kill(container, signal=None)
Kill a container. Similar to the `docker kill` command. Kill a container. Similar to the `docker kill` command.
```python ```python
c.login(username, password=None, email=None) c.login(username, password=None, email=None, registry=None)
``` ```
Identical to the `docker login` command (but non-interactive, obviously). Identical to the `docker login` command (but non-interactive, obviously).
@ -149,19 +149,19 @@ c.port(container, private_port)
Identical to the `docker port` command. Identical to the `docker port` command.
```python ```python
c.pull(repository, tag=None) c.pull(repository, tag=None, stream=False)
``` ```
Identical to the `docker pull` command. Identical to the `docker pull` command.
```python ```python
c.push(repository) c.push(repository, stream=False)
``` ```
Identical to the `docker push` command. Identical to the `docker push` command.
````python ````python
c.remove_container(container, v=False) c.remove_container(container, v=False, link=False)
``` ```
Remove a container. Similar to the `docker rm` command. Remove a container. Similar to the `docker rm` command.
@ -185,7 +185,7 @@ Identical to the `docker search` command.
```python ```python
c.start(container, binds=None, port_bindings=None, lxc_conf=None, c.start(container, binds=None, port_bindings=None, lxc_conf=None,
privileged=False) publish_all_ports=False, links=None, privileged=False)
``` ```
Similar to the `docker start` command, but doesn't support attach Similar to the `docker start` command, but doesn't support attach
@ -210,7 +210,7 @@ c.tag(image, repository, tag=None, force=False)
Identical to the `docker tag` command. Identical to the `docker tag` command.
```python ```python
c.top(container_id) c.top(container)
``` ```
Identical to the `docker top` command. Identical to the `docker top` command.