Adding doc and examples to publish v0.0.1 to pypi

Author: jperelli

.gitignore

@@ -0,0 +1,64 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+#*.mo
+#*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# PyCharm
+.idea/
+
+*.db
+*.sqlite3

Dockerfile

@@ -0,0 +1,13 @@
+FROM python:2.7
+
+ENV PYTHONUNBUFFERED 1
+
+RUN pip install "Django>=1.11.0,<1.12.0".
+
+ADD ./example_project /app
+ADD ./variable_settings /packages/variable_settings
+
+ENV PYTHONPATH /packages/
+WORKDIR /app
+
+ENTRYPOINT ./docker-entrypoint.sh

MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include MANIFEST.in
+include README.md
+recursive-include variable_settings/*
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

README.md

@@ -0,0 +1,72 @@
+# django-variable-settings
+
+A simple django application to manage dynamic settings saved in database using namespaced keys and json string values.
+
+## Demo
+
+To try it now, download this repo and use docker-compose to run it
+
+    git clone git@github.com:jperelli/django-variable-settings.git
+    cd django-variable-settings
+    docker-compose up
+
+Then go to http://localhost:8080/admin and login with user `admin` and password `admin`, you should see the Settings. If you add a settings, it should be a json object. So a string should be saved with double quotes around it.
+
+It can be tested from django shell also easily. Go to another console while `docker-compose up` is running and type
+
+    docker-compose exec django ./manage.py shell
+    >>> import variable_settings
+    >>> variable_settings.set('evergreenstreet', 123)
+    >>> variable_settings.set('address.evergreenstreet', 123)
+    >>> variable_settings.set('address.evergreenavenue', 'first')
+    >>> variable_settings.get('evergreenstreet')
+    123
+    >>> variable_settings.get('address.evergreenavenue')
+    u'first'
+    >>> variable_settings.get('address.*')
+    {u'address.evergreenavenue': u'first', u'address.evergreenstreet': 123}
+    >>> variable_settings.all()
+    {u'address.evergreenavenue': u'first', u'evergreenstreet': 123, u'address.evergreenstreet': 123}
+
+## Installation
+
+    pip install django-variable-settings
+
+In settings.py add
+
+    variable_settings
+
+Then run migrations
+
+    manage.py migrate variable_settings
+
+Then use it as in the Demo
+
+## Settings and custom command
+
+If you want to add some default settings to the database then you can add something like this to `settings.py`
+
+    # default django_variable_settings
+    # use ./manage.py variable_settings_initialize
+    # If overwrite=False(default) they are not applied if already exist in database
+    VARIABLE_SETTINGS = [
+        #[ key , value (, overwrite) ]
+        ['alerting.connection', '127.0.0.1', False],
+        ['alerting.warning', 123, False],
+        ['wrong_permissions.enabled', True, True],
+    ]
+
+Use custom command `./manage.py variable_settings_initialize` to save those in database. The command only overwrites the variable value if the last parameter is set to true
+
+## Caching
+
+WIP
+
+# Authors
+
+ - Julian Perelli
+ - Maxi Padulo
+
+# LICENSE
+
+MIT

docker-compose.yml

@@ -0,0 +1,5 @@
+django:
+    build: .
+    ports:
+        - "0.0.0.0:8080:8080"
+    command: python manage.py runserver 0.0.0.0:8080

example_project/docker-entrypoint.sh

@@ -0,0 +1,3 @@
+python manage.py migrate
+echo "from django.contrib.auth.models import User; User.objects.filter(email='admin@example.com').delete(); User.objects.create_superuser('admin', 'admin@example.com', 'admin')" | python manage.py shell
+python manage.py runserver 0.0.0.0:8080

management/__init__.py …mple_project/example_project/__init__.pymanagement/__init__.py renamed to example_project/example_project/__init__.py management/__init__.py renamed to example_project/example_project/__init__.py

@@ -0,0 +1,121 @@
+"""
+Django settings for example_project project.
+
+Generated by 'django-admin startproject' using Django 1.11.12.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.11/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.11/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'w94-@sp+l334vx&qpamf+&n#+&(5ylm!7*a#6%*cuc+vdx_7b-'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'variable_settings',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'example_project.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'example_project.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.11/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.11/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.11/howto/static-files/
+
+STATIC_URL = '/static/'

example_project/example_project/settings.py

@@ -0,0 +1,22 @@
+"""example_project URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/1.11/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.conf.urls import url, include
+    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
+"""
+from django.conf.urls import include, url
+from django.contrib import admin
+
+urlpatterns = [
+    url(r'^polls/', include('polls.urls')),
+    url(r'^admin/', admin.site.urls),
+]

example_project/example_project/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for example_project 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.11/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example_project.settings")
+
+application = get_wsgi_application()