33[ ![ Build Status] ( https://travis-ci.org/robottaway/unuo.svg?branch=master )] ( https://travis-ci.org/robottaway/unuo ) [ ![ Coverage Status] ( https://img.shields.io/coveralls/robottaway/unuo.svg )] ( https://coveralls.io/r/robottaway/unuo?branch=master )
44
55unuo is a simple Docker tool that allows you to kick off Docker builds from
6- anywhere. Most likely this will involve a CI system calling, which in will
6+ anywhere. It provides a simple RESTful api which allows other tools and scripts
7+ to integrate and have the ability to dockerize.
8+
9+ Most likely this will involve a CI system calling, which in will
710prompt unuo to checkout the required Git repo and using the Dockerfile make a
811container. If you like it can push the container on build to a Docker registry.
912
1013
14+ ## Requirements
15+
16+ There aren't many. You can run on Linux or Mac. You will need:
17+
18+ - [ Python] ( https://www.python.org/ ) 2.7
19+ - [ docker] ( https://www.docker.com/ ) 1+
20+ - [ boot2docker] ( http://boot2docker.io/ ) (if running on Mac)
21+ - [ pip] ( https://pip.readthedocs.org/en/latest/ )
22+
23+ nice to have for installation:
24+
25+ - [ virtualenv] ( http://virtualenv.readthedocs.org/en/latest/ ) (to keep from crufting up the Python site packages)
26+ - [ virtualenvwrapper] ( http://virtualenvwrapper.readthedocs.org/en/latest/ ) (to make working with VEs easy)
27+
28+
1129## Install
1230
1331Installing is pretty simple:
@@ -18,15 +36,32 @@ Installing is pretty simple:
18361 . ``` python setup.py develop ``` if you are developing, otherwise ``` python setup.py install ```
1937
2038
21- ## Running
39+ ## Running on Linux
2240
2341To run the app ``` python unuo/app.py ```
2442
2543
44+ ## Running on Mac
45+
46+ You will be using boot2docker on a mac, which provides a docker command which
47+ while acting like the usual docker command actually proxies request to a linux
48+ VM running a bonafide docker process.
49+
50+ To make this work you will need to ensure that the shell has been configured
51+ properly which means exporting the connection details for this proxy command.
52+ When you run ``` boot2docker start ``` it will finish by printing the 'export'
53+ command you will need to run to make this work.
54+
55+ Make sure that you do this prior to running unuo in a shell otherwise it will
56+ fail to properly invoke the docker proxy command.
57+
58+
2659## Unit Tests
2760
2861First install dependencies: ``` pip install -r requirements_test.txt ```
2962
3063To run the unit tests: ``` python setup.py test ```
3164
3265or if you want to run them and get test coverage: ``` ./coverage.sh ```
66+
67+
0 commit comments