[WIP] Efficiency

[shin-]

For context, see

• Add helper API on top of core API #417 "Add helper API on top of core API"
• tools-project label

What is it?

1. Compilation of helper functions that help perform common tasks outside of the API proper. Example:

In [1]: from docker import efficiency
In [2]: efficiency.start_auto_remove?
Signature: efficiency.start_auto_remove(container, *args, **kwargs)
Docstring:
Start a container and try to remove it when it's finished running,
similar to using --autorm in the docker CLI.

**Params:**
    container: ID of the container to be started
    args, kwargs: `Client.start()` arguments
File:      ~/work/pydocker/docker/efficiency/efficiency.py
Type:      function

1. "Smart objects" providing an object-oriented interface on top of the client layer

In [29]: import docker

In [30]: c = docker.Client()

In [31]: docker.efficiency.init(c)

In [32]: docker.efficiency.get_image('busybox:latest')
Out[32]: <DockerImage(id=d7057cb020844f24)>

In [33]: img = _

In [34]: img.os
Out[34]: u'linux'

In [36]: img.architecture
Out[36]: u'amd64'

In [37]: img.create_container(command='true')
Out[37]: <DockerContainer(id=58bf1374a4116b38)>

In [38]: ctnr = _

In [39]: ctnr.status
Out[39]: 'stopped'

In [40]: ctnr.start()

In [41]: ctnr.wait()
Out[41]: 0 

TODO

• Test coverage
• Documentation (lots of docstring already available)
• Cleanup (smart objects in their own files, etc.)

[dnephin]

efficiency seems a bit strange to me for a module name. What do you think about just making this docker.build ?

[bfirsh]

Carried and merged in #1186. 🎉