[Python-modules-commits] [python-django-etcd-settings] 01/14: importing python-django-etcd-settings_0.1.11+dfsg.orig.tar.gz
Michael Fladischer
fladi at moszumanska.debian.org
Wed Dec 14 10:25:27 UTC 2016
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch master
in repository python-django-etcd-settings.
commit 8f621f963901bc060b322d52b9033ba29d618fae
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Wed Dec 14 09:47:08 2016 +0100
importing python-django-etcd-settings_0.1.11+dfsg.orig.tar.gz
---
.gitignore | 173 +++++++++++++++++++
.pypirc | 14 ++
.travis.yml | 19 +++
Dockerfile | 5 +
LICENSE | 13 ++
MANIFEST.in | 8 +
Makefile | 67 ++++++++
README.rst | 113 +++++++++++++
docker-compose.yml | 11 ++
docs/Makefile | 192 +++++++++++++++++++++
docs/_static/.gitignore | 0
docs/conf.py | 306 ++++++++++++++++++++++++++++++++++
docs/index.rst | 22 +++
docs/installation.rst | 7 +
docs/make.bat | 263 +++++++++++++++++++++++++++++
docs/usage.rst | 7 +
etcd_settings/__init__.py | 5 +
etcd_settings/apps.py | 11 ++
etcd_settings/loader.py | 11 ++
etcd_settings/manager.py | 209 +++++++++++++++++++++++
etcd_settings/proxy.py | 102 ++++++++++++
etcd_settings/utils.py | 150 +++++++++++++++++
requirements.txt | 3 +
requirements/requirements-base.txt | 4 +
requirements/requirements-testing.txt | 13 ++
setup.cfg | 16 ++
setup_gen.py | 29 ++++
tests/__init__.py | 25 +++
tests/conftest.py | 17 ++
tests/loader_dev_params.py | 2 +
tests/test_loader.py | 10 ++
tests/test_manager.py | 259 ++++++++++++++++++++++++++++
tests/test_proxy.py | 127 ++++++++++++++
tests/test_utils.py | 40 +++++
tests/unicode.txt | 1 +
tox.ini | 31 ++++
36 files changed, 2285 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e9c84a9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,173 @@
+# Created by https://www.gitignore.io/api/pycharm,osx,linux,virtualenv,python,vim
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Linux ###
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+### VirtualEnv ###
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+.Python
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ss]cripts
+pyvenv.cfg
+pip-selfcheck.json
+
+
+### Python ###
+# 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
+.python-version
+
+# 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/
+
+### Vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+# Project files
+unittest.sqlite
+/setup.py
diff --git a/.pypirc b/.pypirc
new file mode 100644
index 0000000..242bab4
--- /dev/null
+++ b/.pypirc
@@ -0,0 +1,14 @@
+[distutils] # this tells distutils what package indexes you can push to
+index-servers =
+ pypi
+ pypitest
+
+[pypi]
+repository: https://pypi.python.org/pypi
+username: {{your_username}} # FIXME Set Username
+password: {{your_password}} # FIXME Set Password
+
+[pypitest]
+repository: https://testpypi.python.org/pypi
+username: {{your_username}} # FIXME Set Username
+password: {{your_password}} # FIXME Set Password
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..71be8b0
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,19 @@
+language: python
+sudo: required
+services:
+- docker
+script:
+- make docker/build
+before_install:
+- pip install codecov
+after_success:
+- codecov
+deploy:
+ provider: pypi
+ user: kpn-digital
+ skip_cleanup: true
+ on:
+ tags: true
+ all_branches: true
+ password:
+ secure: gbKikNWaUoKbMjs1IL0PUQaYfqG00TQsIFJwIZq8Ri7wS6dBB9QXZIiUw2uhVrGV6/nXOkqijyxlHsC6Boan6sDgZ3joT9cSlcIq7zur3lT13R28B7uvwIPLaMnz5O+j3KAhB7kSUiJw44Eob9DYmQ0quwwS7V15dKOc49XlxQY6i8qP1KWJ1epkmmgJZIJ2JZNCVy3zAXdRiYD3+yxyLVbbtnl7cLTz7KmmLpnQwAjMV8bD1DqrkLHlWLoIuU+hG9bPlJkLSt749dusBrP2aezEesSPXCWig9g0raBgS7K8MpI2yThztnN1QZFtYoHSdmF8uMSaZ59vwV2tn6yoRC+cOhmHehCmo7QmBXhldk8XhnhCaZvj9R2Ajw+XB5xu1fqHlG89UZKPFVZqTUWuGBmiDb3yeadVeuLJ9EKSSroAHjjyA151hmZ1G4v20nnvuKaJ3TmWzWVHynoWe/jBNkta1kPSJ42g [...]
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..49a031b
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,5 @@
+FROM kpndigital/tox:latest
+
+WORKDIR /app
+
+CMD ["tox"]
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..5b682b8
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2015 KPN Digital
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this application except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..42c19e8
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,8 @@
+include README.md
+include VERSION
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..e9f3509
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,67 @@
+# This Makefile requires the following commands to be available:
+# * virtualenv-2.7
+# * python2.7
+# * docker
+# * docker-compose
+
+DEPS:=requirements.txt
+DOCKER_COMPOSE:=$(shell which docker-compose)
+
+PIP:="venv/bin/pip"
+CMD_FROM_VENV:=". venv/bin/activate; which"
+TOX=$(shell "$(CMD_FROM_VENV)" "tox")
+PYTHON=$(shell "$(CMD_FROM_VENV)" "python")
+TOX_PY_LIST="$(shell $(TOX) -l | grep ^py | xargs | sed -e 's/ /,/g')"
+
+.PHONY: clean docsclean pyclean test lint isort docs docker setup.py
+
+tox: clean venv
+ $(TOX)
+
+pyclean:
+ @find . -name *.pyc -delete
+ @rm -rf *.egg-info build
+ @rm -rf coverage.xml .coverage
+
+docsclean:
+ @rm -fr docs/_build/
+ @rm -fr docs/api/
+
+clean: pyclean docsclean
+ @rm -rf venv
+
+venv:
+ @virtualenv -p python2.7 venv
+ @$(PIP) install -U "pip>=7.0" -q
+ @$(PIP) install -r $(DEPS)
+
+test: venv pyclean
+ $(TOX) -e $(TOX_PY_LIST)
+
+test/%: venv pyclean
+ $(TOX) -e $(TOX_PY_LIST) -- $*
+
+lint: venv
+ @$(TOX) -e lint
+ @$(TOX) -e isort-check
+
+isort: venv
+ @$(TOX) -e isort-fix
+
+docs: venv docsclean
+ @$(TOX) -e docs
+
+docker:
+ $(DOCKER_COMPOSE) run --rm app bash
+
+docker/%:
+ $(DOCKER_COMPOSE) run --rm app make $*
+
+setup.py: venv
+ $(PYTHON) setup_gen.py
+ $(PYTHON) setup.py check --restructuredtext
+
+publish: setup.py
+ $(PYTHON) setup.py sdist upload
+
+build: clean venv tox setup.py
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..d274cce
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,113 @@
+Django ETCD Settings
+=====================
+
+.. image:: https://secure.travis-ci.org/kpn-digital/django-etcd-settings.svg?branch=master
+ :target: http://travis-ci.org/kpn-digital/django-etcd-settings?branch=master
+
+.. image:: https://img.shields.io/codecov/c/github/kpn-digital/django-etcd-settings/master.svg
+ :target: http://codecov.io/github/kpn-digital/django-etcd-settings?branch=master
+
+.. image:: https://img.shields.io/pypi/v/django-etcd-settings.svg
+ :target: https://pypi.python.org/pypi/django-etcd-settings
+
+.. image:: https://readthedocs.org/projects/django-etcd-settings/badge/?version=latest
+ :target: http://django-etcd-settings.readthedocs.org/en/latest/?badge=latest
+
+
+Features
+--------
+
+This application allows you to extend the Django settings as configured in the
+``settings.py`` file with:
+
+* Environment dependent values
+* Values in different config sets, identified by name, which can be selected on
+ a 'per request' basis using the ``X-DYNAMIC-SETTINGS`` HTTP header
+
+Both the added configuration values and config sets would live at ETCD, which
+will be continuously monitored by this library in order to transparently update
+your app settings upon changes.
+
+
+Backends
+--------
+
+- ETCD 2.2.1
+
+
+Installation
+------------
+
+.. code-block:: bash
+
+ $ pip install django-etcd-settings
+
+
+Usage
+-----
+
+This Django application uses the following configuration keys:
+
+* ``DJES_ETCD_DETAILS``: a dict with 'host', 'port', 'protocol', 'prefix',
+ 'long_polling_timeout' and 'long_polling_safety_delay' (both in seconds).
+ 'prefix' is a string to be used as base path for all configuration
+ managed by this app.
+ i.e. '/config/api' will result in '/config/api/<ENV>' and
+ '/config/api/extensions/' to be used for environment defaults and
+ config_sets respectively
+ Timeouts default to 50 and 5 seconds respectively.
+ If ``DJES_ETCD_SETTINGS`` is None, this app will start with no errors and
+ etcd_settings.settings will resolve to django.conf.settings plus your
+ DJES_DEV_PARAMS overwrites
+ i.e.
+
+ .. code-block:: python
+
+ ETCD_DETAILS = dict(
+ host='localhost', port=4000, protocol='http',
+ long_polling_timout=50, long_polling_safety_delay=5
+ )
+
+* ``DJES_DEV_PARAMS``: A module with local overwrites, generally used for
+ development. The overwrites must be capitalized module attributes.
+ These overwrites will have preference over development settings on ETCD,
+ but not over configset overwrites indicated by the ``X-DYNAMIC-SETTINGS``
+ HTTP header
+
+* ``DJES_ENV``: A string with the name of the environment in which the code is
+ running. This will be used for accessing the env_defaults in
+ ETCD in a directory with that name
+ i.e. 'test', 'staging', 'prod'...
+
+* ``DJES_REQUEST_GETTER``: path to a function which accesses the HTTP request
+ object being handled. Ensuring access to this value can be implemented
+ with, for instance, middleware. This settings is only used to allow
+ config overwrites on runtime based on predifined config_sets. In case you
+ don't want to use this functionality, just set this setting to None
+ i.e. 'middleware.thread_local.get_current_request'
+
+* ``DJES_WSGI_FILE``: path to the ``wsgi.py`` file for the django
+ project. If not None, the monitoring of environment configuration will
+ perform a ``touch`` of the file everytime the env_defaults are updated, so
+ that all processes consuming settings from ``django.conf`` can consume the
+ latest settings available as well
+ The path can be absolute or relative to the 'manage.py' file.
+ i.e. /project/src/wsgi.py, wsgi.py
+
+Then, add ``etcd_settings`` to the list of ``INSTALLED_APPS`` before any other that
+requires dynamic settings.
+
+From your code, just do ``from etcd_settings import settings`` instead of ``from
+django.conf import settings``.
+
+In case you want to use ``etcd_settings`` to modify some values in your standard
+Django settings.py file (i.e. Database config), you can use the following
+snippet in your settings file, as high as possible in the file and immediately
+under the ``DJES_*`` settings definition:
+
+ .. code-block:: python
+
+ import etcd_settings.loader
+ extra_settings = etcd_settings.loader.get_overwrites(
+ DJES_ENV, DJES_DEV_PARAMS, DJES_ETCD_DETAILS)
+ locals().update(extra_settings)
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..1450c24
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,11 @@
+etcd:
+ image: elcolio/etcd
+ ports:
+ - "2379:2379"
+app:
+ build: .
+ volumes:
+ - .:/app
+ command: make build
+ links:
+ - etcd
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..77c0e02
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+
+clean:
+ rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-etcd-settings.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-etcd-settings.qhc"
+
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/django-etcd-settings"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-etcd-settings"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore
new file mode 100644
index 0000000..e69de29
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100755
index 0000000..84610cf
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,306 @@
+# -*- coding: utf-8 -*-
+#
+# django-etcd-settings documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct 29 14:40:33 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import shlex
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.mathjax',
+ 'sphinx.ext.napoleon',
+ 'sphinxcontrib.plantuml',
+]
+
+plantuml_jar_path = os.path.abspath('./_plantuml/plantuml.jar')
+plantuml = 'java -Djava.awt.headless=true -jar {0}'.format(plantuml_jar_path)
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-etcd-settings'
+copyright = u'KPN'
+author = u'Enrique Paz'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ' '
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-etcd-settingsdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'django-etcd-settings.tex', u'django-etcd-settings Documentation',
+ u'Enrique Paz', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'django-etcd-settings', u'django-etcd-settings Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
... 1542 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-django-etcd-settings.git
More information about the Python-modules-commits
mailing list