initial

cevaris · cevaris · commit f44d441759bc · 2015-03-03T22:05:05.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+*.sqlite3
+*.pyc
+*.egg*
+
diff --git a/README.rst b/README.rst
@@ -0,0 +1,88 @@
+# EnvConsul
+
+Python environment variable wrapper around Consul key/value storage. When instantiated, `EnvConsol` fetches the key value data for a defined service from Consul. These environment variables are retrievable via the path they were stored in Consul. 
+
+## Features
+
+- Retrieve Consul key/value environment variables service
+- Typed retrieval of environment variables
+- EnvConsol object implements a simple ReadOnly/Immutable dict
+- Implemented using supported Python's Consul `consulate`
+  - (https://github.com/gmr/consulate)[https://github.com/gmr/consulate]
+
+
+## Install
+
+```
+pip install python-envconsul
+```
+
+## Example Usage
+
+### Initialization
+
+```python
+import envconsul
+# where service name is 'web00.django.test'
+ENV_CONSUL = envconsul.EnvConsul('web00.django.test')
+
+# Or if using remote Consul instance
+ENV_CONSUL = envconsul.EnvConsul(
+    host='my.consul.host.com',
+    port=8500,
+    service_name='web00.django.test')
+```
+
+### Retrieval of Environment Variables
+
+```python
+# Taking from django settings file
+
+# Retrun bool type
+DEBUG = ENV_CONSUL.get_bool('/debug', True)
+...
+
+# Return list type
+ALLOWED_HOSTS = []
+ALLOWED_HOSTS += ENV_CONSUL.get_list('/allowed_hosts', [])
+...
+
+# Return tuple type
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+)
+INSTALLED_APPS += ENV_CONSUL.get_tuple('/installed_apps', ['django.contrib.admin',])
+...
+
+# Dictionary example, where Consul key/value path  '/databases/default/engine'
+# maps to the following nested dictionary
+DATABASES = {
+    'default': {
+        'ENGINE': ENV_CONSUL.get_str('/databases/default/engine'),
+        'NAME': os.path.join(BASE_DIR, ENV_CONSUL.get_str('/databases/default/name', 'db.sqlite3')),
+    }
+}
+...
+
+# Simple no-default, no type retrieval; not recommend
+REDIS_HOST = ENV_CONSUL.get('/redis_host')
+```
+
+
+## For Development
+
+Git clone project
+
+`git clone https://github.com/cevaris/python-envconsul.git`
+
+Build and install project
+
+`pip install -r requirements-dev.txt`
+
+Run tests
+
+`py.test tests/`
diff --git a/django_example/README.rst b/django_example/README.rst
@@ -0,0 +1 @@
+# Django Example using python-envconsul
diff --git a/django_example/django_example/__init__.py b/django_example/django_example/__init__.py
diff --git a/django_example/django_example/settings.py b/django_example/django_example/settings.py
@@ -0,0 +1,92 @@
+"""
+Django settings for django_example project.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.7/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.7/ref/settings/
+"""
+import envconsul
+ENV_CONSUL = envconsul.EnvConsul(
+    host="localhost",
+    port=8500,
+    service_name='web00.django.test')
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+import os
+BASE_DIR = os.path.dirname(os.path.dirname(__file__))
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.7/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'n5eah^tt=+tq9^0nym*6zm&*xml)u9(p8r^!5ohl^pnbh$m$!s'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = ENV_CONSUL.get_bool('/debug', True)
+
+TEMPLATE_DEBUG = True
+
+ALLOWED_HOSTS = []
+ALLOWED_HOSTS += ENV_CONSUL.get_list('/allowed_hosts', [])
+
+
+# Application definition
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+)
+INSTALLED_APPS += ENV_CONSUL.get_tuple('/installed_apps', ['django.contrib.admin',])
+
+
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'django_example.urls'
+
+WSGI_APPLICATION = 'django_example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.7/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': ENV_CONSUL.get_str('/databases/default/engine', 'django.db.backends.sqlite3'),
+        'NAME': os.path.join(BASE_DIR, ENV_CONSUL.get_str('/databases/default/name', 'db.sqlite3')),
+    }
+}
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.7/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.7/howto/static-files/
+
+STATIC_URL = '/static/'
+
+
+REDIS_HOST = ENV_CONSUL.get('/redis_host')
diff --git a/django_example/django_example/urls.py b/django_example/django_example/urls.py
@@ -0,0 +1,13 @@
+from django.conf.urls import patterns, include, url
+from django.contrib import admin
+
+from env import views
+
+urlpatterns = patterns('',
+    # Examples:
+    # url(r'^$', 'django_example.views.home', name='home'),
+    # url(r'^blog/', include('blog.urls')),
+
+    url(r'^admin/', include(admin.site.urls)),
+    url(r'^env/', include('env.urls')),
+)
diff --git a/django_example/django_example/wsgi.py b/django_example/django_example/wsgi.py
@@ -0,0 +1,14 @@
+"""
+WSGI config for django_example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/
+"""
+
+import os
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_example.settings")
+
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()
diff --git a/django_example/env/__init__.py b/django_example/env/__init__.py
diff --git a/django_example/env/admin.py b/django_example/env/admin.py
@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.
diff --git a/django_example/env/migrations/__init__.py b/django_example/env/migrations/__init__.py
diff --git a/django_example/env/models.py b/django_example/env/models.py
@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.
diff --git a/django_example/env/tests.py b/django_example/env/tests.py
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
diff --git a/django_example/env/urls.py b/django_example/env/urls.py
@@ -0,0 +1,7 @@
+from django.conf.urls import patterns, url
+
+from env import views
+
+urlpatterns = patterns('',
+        url(r'^$', views.index, name='index'),
+)
diff --git a/django_example/env/views.py b/django_example/env/views.py
@@ -0,0 +1,10 @@
+from django.conf import settings
+from django.http import HttpResponse
+from django.shortcuts import render
+
+
+def index(request):
+    resposne = []
+    for name in dir(settings):
+        resposne.append("{}: {}<br/>".format(name, getattr(settings, name)))
+    return HttpResponse(resposne)
diff --git a/django_example/manage.py b/django_example/manage.py
@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_example.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)
diff --git a/django_example/requirements.txt b/django_example/requirements.txt
@@ -0,0 +1,2 @@
+Django==1.7.2
+-e ../
diff --git a/django_example/set_env.sh b/django_example/set_env.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+# Set environment variables for django_example app
+# Demostation only, should use other tool for managing Consul key/value store
+
+CONSUL_HOST=http://localhost:8500
+curl -X PUT -d 'True' $CONSUL_HOST/v1/kv/web00.django.test/debug
+curl -X PUT -d 'django.db.backends.sqlite3' $CONSUL_HOST/v1/kv/web00.django.test/databases/default/engine
+curl -X PUT -d 'db.envconsul.sqlite3' $CONSUL_HOST/v1/kv/web00.django.test/databases/default/name
+curl -X PUT -d 'django.contrib.admin, env' $CONSUL_HOST/v1/kv/web00.django.test/installed_apps
+curl -X PUT -d '.example.com, .example.com.' $CONSUL_HOST/v1/kv/web00.django.test/allowed_hosts
+echo -e "\nDone setting variables"
diff --git a/envconsul/__init__.py b/envconsul/__init__.py
@@ -0,0 +1,63 @@
+__version__ = '0.0.1'
+
+__all__ = [
+    '__version__',
+]
+
+import collections
+
+from envconsul import utils
+
+from consulate import Consulate
+import requests
+
+
+LIST_DELIM = ','
+DEFAULT_HOST = 'localhost'
+DEFAULT_PORT = 8500
+
+
+class ConsulConnectionFailed(Exception):
+    pass
+
+
+class EnvConsul(collections.Mapping):
+    """Collect Consul key/value data into a dict"""
+
+    def __init__(self, host=DEFAULT_HOST, port=DEFAULT_PORT, service_name=None, *args, **kwargs):
+        self._d = dict(*args, **kwargs)
+
+        self.consul = False
+        try:
+            self.consul = Consulate(host, port)
+            self.consul.kv.items() # Force connection, to test host/port
+        except Exception as e:
+            raise ConsulConnectionFailed(e)
+
+        if service_name and self.consul:
+            self._d.update(utils.get_settings_for(self.consul, service_name))
+
+    def __iter__(self):
+        return iter(self._d)
+
+    def __len__(self):
+        return len(self._d)
+
+    def __getitem__(self, key):
+        return self._d[key]
+
+    def get_bool(self, key, default=None):
+        return bool(self._d.get(key, default))
+
+    def get_str(self, key, default=None):
+        return str(self._d.get(key, default))
+
+    def get_tuple(self, key, default=[]):
+        return tuple(self.get_list(key, default))
+
+    def get_list(self, key, default=[]):
+        data = self._d.get(key, default)
+        if data and LIST_DELIM in data:
+            data = data.split(LIST_DELIM)
+            data = [str(d.strip()) for d in data]
+        return data
diff --git a/envconsul/utils.py b/envconsul/utils.py
@@ -0,0 +1,20 @@
+import copy
+
+import consulate
+
+
+def strip_key_header(text_to_strip, dictionary):
+    dict_copy = copy.copy(dictionary)
+    for k, v in dictionary.items():
+        if k.startswith(text_to_strip):
+            new_key = k.replace(text_to_strip, '', 1)
+            dict_copy[new_key] = v
+            dict_copy.pop(k, None)
+    return dict_copy
+
+
+def get_settings_for(consul, service_name):
+    return strip_key_header(
+        service_name,
+        consul.kv.find(service_name),
+    )
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,4 @@
+[pytest]
+python_paths= .
+looponfailroots= .
+addopts= --tb native
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,2 @@
+ipython==3.0.0
+pytest==2.6.4
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+consulate==0.2.0
+tornado==4.1
diff --git a/setup.py b/setup.py
diff --git a/tests/test_utils.py b/tests/test_utils.py

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +*.sqlite3
 +*.pyc
 +*.egg*
++
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Django Example using python-envconsul`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from django.contrib import admin`
	`2`	`+`
	`3`	`+# Register your models here.`