From b43b95cce2b903848187dbae2d8488eeb168b2e8 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 25 Aug 2011 16:11:22 +0200 Subject: [PATCH] Added Sphinx docs and extended change log. Also added AUTHORS and LICENSE files. --- AUTHORS | 1 + LICENSE | 27 ++++++ MANIFEST.in | 4 +- README.rst | 172 +++++++++------------------------ appconf.py | 6 +- docs/Makefile | 130 +++++++++++++++++++++++++ docs/changelog.rst | 48 +++++++++ docs/conf.py | 220 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 12 +++ docs/installation.rst | 20 ++++ docs/make.bat | 170 ++++++++++++++++++++++++++++++++ docs/reference.rst | 76 +++++++++++++++ docs/usage.rst | 97 +++++++++++++++++++ setup.py | 5 +- 14 files changed, 859 insertions(+), 129 deletions(-) create mode 100644 AUTHORS create mode 100644 LICENSE create mode 100644 docs/Makefile create mode 100644 docs/changelog.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/installation.rst create mode 100644 docs/make.bat create mode 100644 docs/reference.rst create mode 100644 docs/usage.rst diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..875031a --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Jannis Leidel \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8d4cc9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2011, Jannis Leidel and individual contributors. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + * Neither the name of django-appconf nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in index c4bf456..156f3ac 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,3 @@ -include README.rst \ No newline at end of file +include README.rst +include LICENSE +include AUTHORS diff --git a/README.rst b/README.rst index a6d1315..a948a5b 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,16 @@ django-appconf ============== -An app configuration object to be used for handling configuration -defaults of packaged apps gracefully. Say you have an app called ``myapp`` -and want to define a few defaults, and refer to the defaults easily in the -apps code. Add a ``settings.py`` to your app's models.py:: +A helper class for handling configuration defaults of packaged Django +apps gracefully. + +Overview +-------- + +Say you have an app called ``myapp`` with a few defaults, which you want +to refer to in the app's code without repeating yourself all the time. +``appconf`` provides a simple class to implement those defaults. Simply add +something like the following code somewhere in your app files:: from appconf import AppConf @@ -14,132 +20,50 @@ apps code. Add a ``settings.py`` to your app's models.py:: "two", ) - class Meta: - app_label = 'myapp' +.. note:: -The settings are initialized with the app label of where the setting is -located at. E.g. if your ``models.py`` is in the ``myapp`` package, -the prefix of the settings will be ``MYAPP``. + ``AppConf`` classes depend on being imported during startup of the Django + process. Even though there are multiple modules loaded automatically, + only the ``models`` modules (usually the ``models.py`` file of your + app) are guaranteed to be loaded at startup. Therefore it's recommended + to put your ``AppConf`` subclass(es) there, too. -The ``MyAppConf`` class will automatically look at Django's -global setting to determine each of the settings. E.g. adding this to -your site's ``settings.py`` will set the ``SETTING_1`` app setting -accordingly:: +The settings are initialized with the capitalized app label of where the +setting is located at. E.g. if your ``models.py`` with the ``AppConf`` class +is in the ``myapp`` package, the prefix of the settings will be ``MYAPP``. + +You can override the default prefix by specifying a ``prefix`` attribute of +an inner ``Meta`` class:: + + from appconf import AppConf + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + class Meta: + prefix = 'acme' + +The ``MyAppConf`` class will automatically look at Django's global settings +to determine if you've overridden it. For example, adding this to your site's +``settings.py`` would override ``SETTING_1`` of the above ``MyAppConf``:: MYAPP_SETTING_1 = "uno" -Usage ------ +In case you want to use a different settings object instead of the default +``'django.conf.settings'``, set the ``holder`` attribute of the inner +``Meta`` class to a dotted import path:: -Instead of using ``from django.conf import settings`` as you would -usually do, you can **optionally** switch to using your apps own -settings module to access the settings:: - - from myapp.models import MyAppConf - - myapp_settings = MyAppConf() - - print myapp_settings.MYAPP_SETTING_1 - -``AppConf`` class automatically work as proxies for the other -settings, which aren't related to the app. For example the following -code is perfectly valid:: - - from myapp.models import MyAppConf - - settings = MyAppConf() - - if "myapp" in settings.INSTALLED_APPS: - print "yay, myapp is installed!" - -In case you want to set some settings ad-hoc, you can simply pass -the value when instanciating the ``AppConf`` class:: - - from myapp.models import MyAppConf - - settings = MyAppConf(SETTING_1='something completely different') - - if 'different' in settings.MYAPP_SETTINGS_1: - print 'yay, I'm different!' - -Custom handling ---------------- - -Each of the settings can be individually configured with callbacks. -For example, in case a value of a setting depends on other settings -or other dependencies. The following example sets one setting to a -different value depending on a global setting:: - - from django.conf import settings from appconf import AppConf - class MyCustomAppConf(AppConf): - ENABLED = True + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) - def configure_enabled(self, value): - return value and not self.DEBUG - -The value of ``MYAPP_ENABLED`` will vary depending on the -value of the global ``DEBUG`` setting. - -Each of the app settings can be customized by providing -a method ``configure_`` that takes the default -value as defined in the class attributes as the only parameter. -The method needs to return the value to be use for the setting in -question. - -After each of the ``_configure`` method have be called, the ``AppConf`` -class will additionally call a main ``configure`` method, which can -be used to do any further custom configuration handling, e.g. if multiple -settings depend on each other. For that a ``configured_data`` dictionary -is provided in the setting instance:: - - - from django.conf import settings - from appconf import AppConf - - class MyCustomAppConf(AppConf): - ENABLED = True - MODE = 'development' - - def configure_enabled(self, value): - return value and not self.DEBUG - - def configure(self): - mode = self.configured_data['MODE'] - enabled = self.configured_data['ENABLED'] - if not enabled and mode != 'development': - print "WARNING: app not enabled in %s mode!" % mode - -Changelog ---------- - -0.3 (2011-08-23) -^^^^^^^^^^^^^^^^ - -* Added tests with 100% coverage. - -* Added ability to subclass ``Meta`` classes. - -* Fixed various bugs with subclassing and configuration in subclasses. - -0.2.2 (2011-08-22) -^^^^^^^^^^^^^^^^^^ - -* Fixed another issue in the ``configure()`` API. - -0.2.1 (2011-08-22) -^^^^^^^^^^^^^^^^^^ - -* Fixed minor issue in ``configure()`` API. - -0.2 (2011-08-22) -^^^^^^^^^^^^^^^^ - -* Added ``configure()`` API to ``AppConf`` class which is called after - configuring each setting. - -0.1 (2011-08-22) -^^^^^^^^^^^^^^^^ - -* First public release. + class Meta: + prefix = 'acme' + holder = 'acme.conf.settings' diff --git a/appconf.py b/appconf.py index 18252b1..bdcf29c 100644 --- a/appconf.py +++ b/appconf.py @@ -128,8 +128,8 @@ class AppConf(object): def __dir__(self): return sorted(list(set(self._meta.names.keys()))) - @property # For instance access.. + @property def configured_data(self): return self._meta.configured_data @@ -152,6 +152,8 @@ class AppConf(object): def configure(self): """ - Hook for doing any extra configuration. + Hook for doing any extra configuration, returning a dictionary + containing the configured data. + """ return self.configured_data diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..a79ced0 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where 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 " 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 " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in 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-appconf.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-appconf.qhc" + +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-appconf" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-appconf" + @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." + +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." + +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." diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..97eca4a --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,48 @@ +Changelog +========= + +0.4 (2011-08-24) +---------------- + +* Renamed ``app_label`` attribute of the inner ``Meta`` class to ``prefix``. + The old form ``app_label`` will work in the meantime. + +* Added ``holder`` attribute to the inner ``Meta`` class to be able to + specify a custom "global" setting holder. Default: "'django.conf.settings'" + +* Added ``proxy`` attribute to the inner ``Meta`` class to enable proxying + of ``AppConf`` instances to the settings holder, e.g. the global Django + settings. + +* Fixed issues with ``configured_data`` dictionary available in the + ``configure`` method of ``AppConf`` classes with regard to subclassing. + +0.3 (2011-08-23) +---------------- + +* Added tests with 100% coverage. + +* Added ability to subclass ``Meta`` classes. + +* Fixed various bugs with subclassing and configuration in subclasses. + +0.2.2 (2011-08-22) +------------------ + +* Fixed another issue in the ``configure()`` API. + +0.2.1 (2011-08-22) +------------------ + +* Fixed minor issue in ``configure()`` API. + +0.2 (2011-08-22) +---------------- + +* Added ``configure()`` API to ``AppConf`` class which is called after + configuring each setting. + +0.1 (2011-08-22) +---------------- + +* First public release. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3a71915 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,220 @@ +# -*- coding: utf-8 -*- +# +# django-appconf documentation build configuration file, created by +# sphinx-quickstart on Thu Aug 25 14:26:22 2011. +# +# 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, os + +# 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.intersphinx', 'sphinx.ext.coverage'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +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-appconf' +copyright = u'2011, Jannis Leidel and individual contributors' + +# 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 = '0.3' +# The full version, including alpha/beta/rc tags. +release = '0.3' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#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 = [] + + +# -- 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 = 'default' + +# 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 +# " v 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'] + +# 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 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 + +# Output file base name for HTML help builder. +htmlhelp_basename = 'django-appconfdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'django-appconf.tex', u'django-appconf Documentation', + u'Jannis Leidel and individual contributors', '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 + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# 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 = [ + ('index', 'django-appconf', u'django-appconf Documentation', + [u'Jannis Leidel and individual contributors'], 1) +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..4ea4a36 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,12 @@ +.. include:: ../README.rst + +Contents +======== + +.. toctree:: + :maxdepth: 1 + + installation + usage + reference + changelog diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..705404e --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,20 @@ +Installation +============ + +* Install django-appconf with your favorite Python package manager:: + + pip install django-appconf + +* Add ``'appconf'`` to your ``INSTALLED_APPS`` setting:: + + INSTALLED_APPS = ( + # other apps + "appconf", + ) + + +.. _staticfiles: http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/ +.. _django-staticfiles: http://pypi.python.org/pypi/django-staticfiles + +.. _dependencies: + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..e4d8a9e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,170 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ 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. 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. text to make text files + echo. man to make manual pages + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-appconf.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-appconf.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/docs/reference.rst b/docs/reference.rst new file mode 100644 index 0000000..fc18479 --- /dev/null +++ b/docs/reference.rst @@ -0,0 +1,76 @@ +========= +Reference +========= + +.. currentmodule:: appconf + +.. class:: AppConf + + A representation of a template tag. For example:: + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + .. method:: configure_*(value) + + Method for each of the app settings for custom configuration + which gets the value passed of the class attribute or the + appropriate override value of the :attr:`~appconf.AppConf.Meta.holder` + settings, e.g.:: + + class MyAppConf(AppConf): + DEPLOYMENT_MODE = "dev" + + def configure_deployment_mode(self, value): + if on_production(): + value = "prod" + return value + + The method **must return** the value to be use for the setting in + question. + + .. automethod:: configure + .. autoattribute:: configured_data + + The dictionary attribute which can be used to do any further custom + configuration handling in the :meth:`~appconf.AppConf.configure` + method, e.g. if multiple settings depend on each other. + +.. class:: AppConf.Meta + + An ``AppConf`` takes options via a ``Meta`` inner class:: + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + class Meta: + proxy = False + prefix = 'myapp' + holder = 'django.conf.settings' + + .. attribute:: prefix + + Explicitly choose a prefix for all settings handled by the + ``AppConf`` class. If not given, the prefix will be the capitalized + class module name. + + For example, ``acme`` would turn into settings like + ``ACME_SETTING_1``. + + .. attribute:: holder + + The global settings holder to use when looking for overrides and + when setting the configured values. + + Defaults to ``'django.conf.settings'``. + + .. attribute:: proxy + + A boolean, if set to ``True`` will enable proxying attribute access + to the :attr:`~appconf.AppConf.Meta.holder`. diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..ba9031e --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,97 @@ +.. _usage:: + +Usage +===== + +It's strongly recommended to use the usual ``from django.conf import settings`` +in your own code to access the configured settings. + +But you can also **OPTIONALLY** use your app's own settings object directly, +by instantiating it in place:: + + from myapp.models import MyAppConf + + myapp_settings = MyAppConf() + + print myapp_settings.SETTING_1 + +Note that accessing the settings that way means they don't have a prefix. + +``AppConf`` instances don't automatically work as proxies for the global +settings. But you can enable this if you want by setting the ``proxy`` +attribute of the inner ``Meta`` class to ``True``:: + + from appconf import AppConf + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + class Meta: + proxy = True + + myapp_settings = MyAppConf() + + if "myapp" in myapp_settings.INSTALLED_APPS: + print "yay, myapp is installed!" + +In case you want to override some settings programmatically, you can +simply pass the value when instantiating the ``AppConf`` class:: + + from myapp.models import MyAppConf + + myapp_settings = MyAppConf(SETTING_1='something completely different') + + if 'different' in myapp_settings.SETTINGS_1: + print 'yay, I'm different!' + +Custom configuration +-------------------- + +Each of the settings can be individually configured with callbacks. +For example, in case a value of a setting depends on other settings +or other dependencies. The following example sets one setting to a +different value depending on a global setting:: + + from django.conf import settings + from appconf import AppConf + + class MyCustomAppConf(AppConf): + ENABLED = True + + def configure_enabled(self, value): + return value and not settings.DEBUG + +The value of ``MYAPP_ENABLED`` will vary depending on the +value of the global ``DEBUG`` setting. + +Each of the app settings can be customized by providing +a method ``configure_`` that takes the default +value as defined in the class attributes of the ``AppConf`` subclass +or the override value from the global settings as the only parameter. +The method **must return** the value to be use for the setting in +question. + +After each of the ``*_configure`` methods have been called, the ``AppConf`` +class will additionally call a main ``configure`` method, which can +be used to do any further custom configuration handling, e.g. if multiple +settings depend on each other. For that a ``configured_data`` dictionary +is provided in the setting instance:: + + from django.conf import settings + from appconf import AppConf + + class MyCustomAppConf(AppConf): + ENABLED = True + MODE = 'development' + + def configure_enabled(self, value): + return value and not settings.DEBUG + + def configure(self): + mode = self.configured_data['MODE'] + enabled = self.configured_data['ENABLED'] + if not enabled and mode != 'development': + print "WARNING: app not enabled in %s mode!" % mode diff --git a/setup.py b/setup.py index 15c1404..18f5863 100644 --- a/setup.py +++ b/setup.py @@ -7,11 +7,12 @@ read = lambda filepath: codecs.open(filepath, 'r', 'utf-8').read() setup( name='django-appconf', version=":versiontools:appconf:", - description='An app configuration object to be used for handling ' - 'configuration defaults of packaged apps gracefully.', + description='A helper class for handling configuration defaults ' + 'of packaged apps gracefully.', long_description=read(path.join(path.dirname(__file__), 'README.rst')), author='Jannis Leidel', author_email='jannis@leidel.info', + license = 'BSD', url='https://github.com/jezdez/django-appconf/', py_modules=['appconf'], classifiers=[