Edit File: api-overview.html
<!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"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Kitchen API — kitchen 1.1.1 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '', VERSION: '1.1.1', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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> <link rel="search" type="application/opensearchdescription+xml" title="Search within kitchen 1.1.1 documentation" href="_static/opensearch.xml"/> <link rel="top" title="kitchen 1.1.1 documentation" href="index.html" /> <link rel="next" title="Kitchen.i18n Module" href="api-i18n.html" /> <link rel="prev" title="Designing Unicode Aware APIs" href="designing-unicode-apis.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="api-i18n.html" title="Kitchen.i18n Module" accesskey="N">next</a> |</li> <li class="right" > <a href="designing-unicode-apis.html" title="Designing Unicode Aware APIs" accesskey="P">previous</a> |</li> <li><a href="index.html">kitchen 1.1.1 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="kitchen-api"> <span id="kitchenapi"></span><h1>Kitchen API<a class="headerlink" href="#kitchen-api" title="Permalink to this headline">ΒΆ</a></h1> <p>Kitchen is structured as a collection of modules. In its current configuration, Kitchen ships with the following modules. Other addon modules that may drag in more dependencies can be found on the <a class="reference external" href="https://fedorahosted.org/kitchen">project webpage</a></p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="api-i18n.html">Kitchen.i18n Module</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-i18n.html#functions">Functions</a></li> <li class="toctree-l2"><a class="reference internal" href="api-i18n.html#translation-objects">Translation Objects</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-text.html">Kitchen.text: unicode and utf8 and xml oh my!</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-text-converters.html">Kitchen.text.converters</a></li> <li class="toctree-l2"><a class="reference internal" href="api-text-converters.html#functions">Functions</a></li> <li class="toctree-l2"><a class="reference internal" href="api-text-display.html">Format Text for Display</a></li> <li class="toctree-l2"><a class="reference internal" href="api-text-display.html#internal-data">Internal Data</a></li> <li class="toctree-l2"><a class="reference internal" href="api-text-misc.html">Miscellaneous functions for manipulating text</a></li> <li class="toctree-l2"><a class="reference internal" href="api-text-utf8.html">UTF-8</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-collections.html">Kitchen.collections</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-collections.html#strictdict">StrictDict</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-iterutils.html">Kitchen.iterutils Module</a></li> <li class="toctree-l1"><a class="reference internal" href="api-versioning.html">Helpers for versioning software</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-versioning.html#pep-386-compliant-versioning">PEP-386 compliant versioning</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-pycompat24.html">Python 2.4 Compatibiity</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-pycompat24.html#module-kitchen.pycompat24.sets">Sets for python-2.3</a></li> <li class="toctree-l2"><a class="reference internal" href="api-pycompat24.html#module-kitchen.pycompat24.base64">Partial new style base64 interface</a></li> <li class="toctree-l2"><a class="reference internal" href="api-pycompat24.html#subprocess">Subprocess</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-pycompat25.html">Python 2.5 Compatibility</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-pycompat25.html#defaultdict">defaultdict</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-pycompat27.html">Python 2.7 Compatibility</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-pycompat27.html#subprocess-from-python-2-7">Subprocess from Python 2.7</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-exceptions.html">Exceptions</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-exceptions.html#base-kitchen-exceptions">Base kitchen exceptions</a></li> <li class="toctree-l2"><a class="reference internal" href="api-exceptions.html#kitchen-text-exceptions">Kitchen.text exceptions</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="designing-unicode-apis.html" title="previous chapter">Designing Unicode Aware APIs</a></p> <h4>Next topic</h4> <p class="topless"><a href="api-i18n.html" title="next chapter">Kitchen.i18n Module</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/api-overview.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <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> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="api-i18n.html" title="Kitchen.i18n Module" >next</a> |</li> <li class="right" > <a href="designing-unicode-apis.html" title="Designing Unicode Aware APIs" >previous</a> |</li> <li><a href="index.html">kitchen 1.1.1 documentation</a> »</li> </ul> </div> <div class="footer"> © Copyright 2011 Red Hat, Inc. and others. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>