/charms.docker

Docs to go with the 0.1.0 release #14

Merged
merged 6 commits into from Mar 31, 2016

Conversation

Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
  v0.1.0
3 participants
@chuckbutler @coveralls @mbruzek
@chuckbutler
Collaborator

chuckbutler commented Mar 24, 2016

No description provided.

chuckbutler added some commits Mar 24, 2016

@chuckbutler
Module Restructuring 
This commit restructures the core of charms.docker to follow the python best practice of import modules in the __init__.py file for a nicer UX

You can now import like so:

`from charms.docker import Compose`
or
`from charms.docker import DockerOpts`

This also brings with it a pretty hefty update to the Compose class, implementing methods and tests for the following methods:

 - start
- stop
- pull
- restart
- build
- scale

It also splits apart the private __run method into a separate module known as 'runner'.
9998ecd
@chuckbutler
Adds VERSION file to track project version
db2fdb9
@chuckbutler
bump to 0.1.0 per PR

All checks have passed

2 successful checks
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
coverage/coveralls — First build on master at 96.622%
Details
3de5650
@chuckbutler
Docs to accompany the 0.1.0 release

All checks have passed

2 successful checks
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
coverage/coveralls — First build on master at 96.622%
Details
aaad87f
@coveralls

coveralls commented Mar 24, 2016

Coverage Status

Changes Unknown when pulling aaad87f on chuckbutler:Docs into * on juju-solutions:master*.

@chuckbutler chuckbutler added the enhancement label Mar 31, 2016

@chuckbutler chuckbutler added this to the v0.1.0 milestone Mar 31, 2016

charms/docker/docker.py
+ a charmer. Provides stateless operations of a running docker daemon
+ '''
+
+ def __init__(self, socket="unix:///var/run/docker.sock", workspace=None):
@mbruzek

mbruzek Mar 31, 2016

Contributor

too many slashes here. I don't think you were intending for unix colon slash slash slash

@chuckbutler

chuckbutler Mar 31, 2016

Collaborator

Are you sure? :) See the daemon options, specifically the -H option: https://docs.docker.com/engine/quickstart/

@mbruzek

mbruzek Mar 31, 2016

Contributor

OK I see the issue, it is using the third slash as the root dir. If this is correct, you should fix all other uses that do not have three slashes.

@chuckbutler

chuckbutler Mar 31, 2016

Collaborator

Done, and done. Thanks for pointing that out, I completely missed it even after you called out the funky one that was indeed correct. #whatamidoingwithmylife

charms/docker/dockeropts.py
@@ -2,8 +2,8 @@
class DockerOpts:
-
- ''' DockerOptsManager - A Python class for managing the DEFAULT docker
+ '''
@mbruzek

mbruzek Mar 31, 2016

Contributor

nit: From what I understand about Python docstrings, they start RIGHT after the third tick, so this puts a new line character as the first character. I read up on this, and I understand that the previous way was "more correct". You don't need to change it, but just keep that in mind. At this point is makes more sense to be consistent rather than "more correct" so nevermind me.

@chuckbutler
Remove leftover traces that I copied the template tree from amulet

All checks have passed

2 successful checks
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
coverage/coveralls — First build on master at 96.622%
Details
928d11c
@coveralls

coveralls commented Mar 31, 2016

Coverage Status

Changes Unknown when pulling 928d11c on chuckbutler:Docs into * on juju-solutions:master*.
@chuckbutler
Correct the incorrect unix sockets

All checks have passed

2 successful checks
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
coverage/coveralls — First build on master at 96.622%
Details
26debea
@coveralls

coveralls commented Mar 31, 2016

Coverage Status

Changes Unknown when pulling 26debea on chuckbutler:Docs into * on juju-solutions:master*.
@mbruzek
Contributor

mbruzek commented Mar 31, 2016

The code looks good to me. I am not a restructured text expert, so not sure there. The coverage is high and the tests pass +1.

@mbruzek mbruzek merged commit 8b8fe79 into juju-solutions:master Mar 31, 2016
2 checks passed

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls First build on master at 96.622%
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment