dockercloud

Author: tifayuki

.gitignore

@@ -2,8 +2,6 @@
 __pycache__/
 *.py[cod]
 
-# C extensions
-*.so
 
 # Distribution / packaging
 .Python
@@ -22,6 +20,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+venv/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -55,3 +54,8 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# IDE
+.idea/
+
+venv/

Makefile

@@ -0,0 +1,13 @@
+test:prepare
+	venv/bin/python setup.py test
+
+clean:
+	rm -rf venv build dist *.egg-info
+	find . -name '*.pyc' -delete
+
+prepare:clean
+	set -ex
+	virtualenv venv
+	venv/bin/pip install mock
+	venv/bin/pip install -r requirements.txt
+	venv/bin/python setup.py install

README.md

@@ -1,2 +1,80 @@
 # python-docker-cloud
+
 Python library for Docker Cloud
+
+## Installation
+
+In order to install the Docker Cloud Python library, you can use pip install:
+
+	pip install python-dockercloud
+
+It will install a Python module called dockercloud which you can use to interface with the API.
+
+## Authorization
+
+The authentication can be configured in the following ways:
+
+* Manually set it in your Python initialization code:
+
+		import dockercloud
+		dockercloud.user = "username"
+		dockercloud.apikey = "apikey"
+
+* Login with docker cli, and the library will read the configfile automatically:
+
+		$ docker login
+
+* Set the environment variables DOCKERCLOUD_USER and DOCKERCLOUD_APIKEY:
+
+		export DOCKERCLOUD_USER=username
+		export DOCKERCLOUD_APIKEY=apikey
+
+## Errors
+
+Errors in the HTTP API will be returned with status codes in the 4xx and 5xx ranges.
+
+The Python library will detect this status codes and raise ApiError exceptions with the error message, which should be handled by the calling application accordingly.
+
+
+## Quick examples
+
+### Services
+
+	>>> import dockercloud
+	>>> dockercloud.Service.list()
+	[<dockercloud.api.service.Service object at 0x10701ca90>, <dockercloud.api.service.Service 	object at 0x10701ca91>]
+	>>> service = dockercloud.Service.fetch("fee900c6-97da-46b3-a21c-e2b50ed07015")
+	<dockercloud.api.service.Service object at 0x106c45c10>
+	>>> service.name
+	"my-python-app"
+	>>> service = dockercloud.Service.create(image="dockercloud/hello-world", name="my-new-	app", target_num_containers=2)
+	>>> service.save()
+	True
+	>>> service.target_num_containers = 3
+	>>> service.save()
+	True
+	>>> service.stop()
+	True
+	>>> service.start()
+	True
+	>>> service.delete()
+	True
+
+### Containers
+
+	>>> import dockercloud
+	>>> dockercloud.Container.list()
+	[<dockercloud.api.container.Container object at 0x10701ca90>, <dockercloud.api.container.Container object at 0x10701ca91>]
+	>>> container = dockercloud.Container.fetch("7d6696b7-fbaf-471d-8e6b-ce7052586c24")
+	<dockercloud.api.container.Container object at 0x10701ca90>
+	>>> container.public_dns = "my-web-app.example.com"
+	>>> container.save()
+	True
+	>>> container.stop()
+	True
+	>>> container.start()
+	True
+	>>> container.logs()
+	"2014-03-24 23:58:08,973 CRIT Supervisor running as root (no user in config 	file) [...]"
+	>>> container.delete()
+	True

dockercloud/__init__.py

@@ -0,0 +1,49 @@
+import base64
+import logging
+import os
+
+import requests
+from future.standard_library import install_aliases
+
+install_aliases()
+
+from dockercloud.api import auth
+from dockercloud.api.service import Service
+from dockercloud.api.container import Container
+from dockercloud.api.repository import Repository
+from dockercloud.api.node import Node
+from dockercloud.api.action import Action
+from dockercloud.api.nodecluster import NodeCluster
+from dockercloud.api.nodetype import NodeType
+from dockercloud.api.nodeprovider import Provider
+from dockercloud.api.noderegion import Region
+from dockercloud.api.tag import Tag
+from dockercloud.api.trigger import Trigger
+from dockercloud.api.stack import Stack
+from dockercloud.api.exceptions import ApiError, AuthError, ObjectNotFound, NonUniqueIdentifier
+from dockercloud.api.utils import Utils
+from dockercloud.api.events import Events
+from dockercloud.api.nodeaz import AZ
+
+__version__ = '1.0.0'
+
+dockercloud_auth = os.environ.get('DOCKERCLOUD_AUTH')
+basic_auth = auth.load_from_file("~/.docker/config.json")
+
+if os.environ.get('DOCKERCLOUD_USER') and os.environ.get('DOCKERCLOUD_PASS'):
+    basic_auth = base64.b64encode("%s:%s" % (os.environ.get('DOCKERCLOUD_USER'), os.environ.get('DOCKERCLOUD_PASS')))
+if os.environ.get('DOCKERCLOUD_USER') and os.environ.get('DOCKERCLOUD_APIKEY'):
+    basic_auth = base64.b64encode("%s:%s" % (os.environ.get('DOCKERCLOUD_USER'), os.environ.get('DOCKERCLOUD_APIKEY')))
+
+rest_host = os.environ.get("DOCKERCLOUD_REST_HOST") or 'https://cloud.docker.com/'
+stream_host = os.environ.get("DOCKERCLOUD_STREAM_HOST") or 'wss://ws.cloud.docker.com/'
+
+user_agent = None
+
+logging.basicConfig()
+logger = logging.getLogger("python-dockercloud")
+
+try:
+    requests.packages.urllib3.disable_warnings()
+except:
+    pass

dockercloud/api/__init__.py

@@ -0,0 +1,23 @@
+from __future__ import absolute_import
+
+from .base import Immutable, StreamingLog
+
+
+class Action(Immutable):
+    subsystem = 'audit'
+    endpoint = "/action"
+
+    @classmethod
+    def _pk_key(cls):
+        return 'uuid'
+
+    def logs(self, tail, follow, log_handler=StreamingLog.default_log_handler):
+        logs = StreamingLog(self.subsystem, self.endpoint, self.pk, tail, follow)
+        logs.on_message(log_handler)
+        logs.run_forever()
+
+    def cancel(self):
+        return self._perform_action("cancel")
+
+    def retry(self):
+        return self._perform_action("retry")

dockercloud/api/action.py

@@ -0,0 +1,67 @@
+from __future__ import absolute_import
+
+import base64
+import json
+import os
+
+from requests.auth import HTTPBasicAuth
+
+import dockercloud
+from .http import send_request
+
+
+def authenticate(username, password):
+    verify_credential(username, password)
+    dockercloud.basic_auth = base64.b64encode("%s:%s" % (username, password))
+
+
+def verify_credential(username, password):
+    auth = HTTPBasicAuth(username, password)
+    send_request("GET", "/auth", auth=auth)
+
+
+def is_authenticated():
+    try:
+        dockercloud.basic_auth = base64.b64encode("%s:%s" % (dockercloud.user, dockercloud.password))
+    except:
+        pass
+
+    try:
+        dockercloud.basic_auth = base64.b64encode("%s:%s" % (dockercloud.user, dockercloud.apikey))
+    except:
+        pass
+
+    return dockercloud.dockercloud_auth or dockercloud.basic_auth
+
+
+def logout():
+    dockercloud.dockercloud_auth = None
+    dockercloud.basic_auth = None
+
+
+def load_from_file(f="~/.docker/config.json"):
+    try:
+        with open(os.path.expanduser(f)) as config_file:
+            data = json.load(config_file)
+
+        return data.get("auths", {}).get("https://index.docker.io/v1/", {}).get("auth", None)
+    except Exception:
+        return None
+
+
+def get_auth_header():
+    try:
+        dockercloud.basic_auth = base64.b64encode("%s:%s" % (dockercloud.user, dockercloud.password))
+    except:
+        pass
+
+    try:
+        dockercloud.basic_auth = base64.b64encode("%s:%s" % (dockercloud.user, dockercloud.apikey))
+    except:
+        pass
+
+    if dockercloud.dockercloud_auth:
+        return {'Authorization': dockercloud.dockercloud_auth}
+    if dockercloud.basic_auth:
+        return {'Authorization': 'Basic %s' % dockercloud.basic_auth}
+    return {}