CINXE.COM
Invenio-Config — Invenio-Config 1.0.3 documentation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Invenio-Config — Invenio-Config 1.0.3 documentation</title> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Installation" href="installation.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <!-- RTD Extra Head --> <!-- Always link to the latest version, as canonical. http://docs.readthedocs.org/en/latest/canonical.html --> <link rel="canonical" href="https://invenio-config.readthedocs.io/en/latest/" /> <script type="text/javascript" src="_static/readthedocs-data.js"></script> <!-- Add page-specific data, which must exist in the page js, not global --> <script type="text/javascript"> READTHEDOCS_DATA['page'] = "index" READTHEDOCS_DATA['source_suffix'] = ".rst" </script> <!-- end RTD <extrahead> --> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="invenio-config" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head><body> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="invenio-config"> <h1>Invenio-Config<a class="headerlink" href="#invenio-config" title="Permalink to this headline">露</a></h1> <a class="reference external image-reference" href="https://github.com/inveniosoftware/invenio-config/blob/master/LICENSE"><img alt="https://img.shields.io/github/license/inveniosoftware/invenio-config.svg" src="https://img.shields.io/github/license/inveniosoftware/invenio-config.svg" /></a> <a class="reference external image-reference" href="https://travis-ci.org/inveniosoftware/invenio-config"><img alt="https://img.shields.io/travis/inveniosoftware/invenio-config.svg" src="https://img.shields.io/travis/inveniosoftware/invenio-config.svg" /></a> <a class="reference external image-reference" href="https://coveralls.io/r/inveniosoftware/invenio-config"><img alt="https://img.shields.io/coveralls/inveniosoftware/invenio-config.svg" src="https://img.shields.io/coveralls/inveniosoftware/invenio-config.svg" /></a> <a class="reference external image-reference" href="https://pypi.org/pypi/invenio-config"><img alt="https://img.shields.io/pypi/v/invenio-config.svg" src="https://img.shields.io/pypi/v/invenio-config.svg" /></a> <p>Invenio configuration loader.</p> <p>Invenio-Config is a base package of the Invenio digital library framework. It is usually installed automatically as a dependency. It facilitates configuration loading from various sources such as a Python module, an instance folder or environment variables.</p> <p>Further documentation is available on <a class="reference external" href="https://invenio-config.readthedocs.io/">https://invenio-config.readthedocs.io/</a>.</p> <div class="section" id="user-s-guide"> <h2>User鈥檚 Guide<a class="headerlink" href="#user-s-guide" title="Permalink to this headline">露</a></h2> <p>This part of the documentation will show you how to get started in using Invenio-Config.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage.html#initialization">Initialization</a></li> <li class="toctree-l2"><a class="reference internal" href="usage.html#loaders">Loaders</a></li> <li class="toctree-l2"><a class="reference internal" href="usage.html#factory-pattern">Factory Pattern</a></li> </ul> </li> </ul> </div> </div> <div class="section" id="api-reference"> <h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">露</a></h2> <p>If you are looking for information on a specific function, class or method, this part of the documentation is for you.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="api.html">API Docs</a><ul> <li class="toctree-l2"><a class="reference internal" href="api.html#module-invenio_config.default">Loaders</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#module-invenio_config.utils">Utilities</a></li> </ul> </li> </ul> </div> </div> <div class="section" id="additional-notes"> <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permalink to this headline">露</a></h2> <p>Notes on how to contribute, legal information and changes are here for the interested.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="changes.html">Changes</a></li> <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li> <li class="toctree-l1"><a class="reference internal" href="authors.html">Contributors</a></li> </ul> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h1 class="logo"><a href="#">Invenio-Config</a></h1> <p class="blurb">Invenio configuration loader.</p> <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="api.html">API Docs</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="changes.html">Changes</a></li> <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li> <li class="toctree-l1"><a class="reference internal" href="authors.html">Contributors</a></li> </ul> <hr /> <ul> <li class="toctree-l1"><a href="https://github.com/inveniosoftware/invenio-config">invenio-config@GitHub</a></li> <li class="toctree-l1"><a href="https://pypi.python.org/pypi/invenio-config/">invenio-config@PyPI</a></li> </ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="#">Documentation overview</a><ul> <li>Next: <a href="installation.html" title="next chapter">Installation</a></li> </ul></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="footer"> ©2015, CERN. | <a href="_sources/index.rst.txt" rel="nofollow">Page source</a> </div> <a href="https://github.com/inveniosoftware/invenio-config" class="github"> <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/> </a> </body> </html>