anoopmb
/
frappe



<!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>Project Modules &mdash; WNFramework v1.8 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.8',
        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="top" title="WNFramework v1.8 documentation" href="index.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><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="project-modules">
<h1>Project Modules<a class="headerlink" href="#project-modules" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="core.html">core Package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="core.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="core.doctype.html">doctype Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="core.doctype.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.control_panel.html">control_panel Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.control_panel.html#control-panel-module"><tt class="docutils literal"><span class="pre">control_panel</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.custom_field.html">custom_field Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.custom_field.html#custom-field-module"><tt class="docutils literal"><span class="pre">custom_field</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.doctype.html">doctype Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.doctype.html#doctype-module"><tt class="docutils literal"><span class="pre">doctype</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.doctype_mapper.html">doctype_mapper Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.doctype_mapper.html#doctype-mapper-module"><tt class="docutils literal"><span class="pre">doctype_mapper</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.letter_head.html">letter_head Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.letter_head.html#letter-head-module"><tt class="docutils literal"><span class="pre">letter_head</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.module_def.html">module_def Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.module_def.html#module-def-module"><tt class="docutils literal"><span class="pre">module_def</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.page.html">page Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.page.html#module-core.doctype.page.page"><tt class="docutils literal"><span class="pre">page</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.page_template.html">page_template Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.page_template.html#module-core.doctype.page_template.page_template"><tt class="docutils literal"><span class="pre">page_template</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.profile.html">profile Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.profile.html#profile-module"><tt class="docutils literal"><span class="pre">profile</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.property_setter.html">property_setter Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.property_setter.html#module-core.doctype.property_setter.property_setter"><tt class="docutils literal"><span class="pre">property_setter</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.search_criteria.html">search_criteria Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.search_criteria.html#search-criteria-module"><tt class="docutils literal"><span class="pre">search_criteria</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.stylesheet.html">stylesheet Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.stylesheet.html#module-core.doctype.stylesheet.stylesheet"><tt class="docutils literal"><span class="pre">stylesheet</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="core.doctype.system_console.html">system_console Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="core.doctype.system_console.html#system-console-module"><tt class="docutils literal"><span class="pre">system_console</span></tt> Module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="core.page.html">page Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="core.page.html#subpackages">Subpackages</a><ul class="simple">
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="webnotes.html">webnotes Package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#id1"><tt class="docutils literal"><span class="pre">webnotes</span></tt> Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.auth"><tt class="docutils literal"><span class="pre">auth</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.db"><tt class="docutils literal"><span class="pre">db</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.defs"><tt class="docutils literal"><span class="pre">defs</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.defs_template"><tt class="docutils literal"><span class="pre">defs_template</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.handler"><tt class="docutils literal"><span class="pre">handler</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.profile"><tt class="docutils literal"><span class="pre">profile</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.session_cache"><tt class="docutils literal"><span class="pre">session_cache</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.tests"><tt class="docutils literal"><span class="pre">tests</span></tt> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="webnotes.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webnotes.install_lib.html">install_lib Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webnotes.install_lib.html#module-webnotes.install_lib.db_init"><tt class="docutils literal"><span class="pre">db_init</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.install_lib.html#module-webnotes.install_lib.install"><tt class="docutils literal"><span class="pre">install</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="webnotes.model.html">model Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#id1"><tt class="docutils literal"><span class="pre">model</span></tt> Package</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.code"><tt class="docutils literal"><span class="pre">code</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.db_schema"><tt class="docutils literal"><span class="pre">db_schema</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doc"><tt class="docutils literal"><span class="pre">doc</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doclist"><tt class="docutils literal"><span class="pre">doclist</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doctype"><tt class="docutils literal"><span class="pre">doctype</span></tt> Module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="webnotes.model.html#id2">DocType module</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.import_docs"><tt class="docutils literal"><span class="pre">import_docs</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.meta"><tt class="docutils literal"><span class="pre">meta</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.modules"><tt class="docutils literal"><span class="pre">modules</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.triggers"><tt class="docutils literal"><span class="pre">triggers</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="webnotes.modules.html">modules Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#id1"><tt class="docutils literal"><span class="pre">modules</span></tt> Package</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.compress"><tt class="docutils literal"><span class="pre">compress</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.export_module"><tt class="docutils literal"><span class="pre">export_module</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.import_module"><tt class="docutils literal"><span class="pre">import_module</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.module_manager"><tt class="docutils literal"><span class="pre">module_manager</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.patch"><tt class="docutils literal"><span class="pre">patch</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="webnotes.multi_tenant.html">multi_tenant Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webnotes.multi_tenant.html#id1"><tt class="docutils literal"><span class="pre">multi_tenant</span></tt> Package</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.multi_tenant.html#query-parser-module"><tt class="docutils literal"><span class="pre">query_parser</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.multi_tenant.html#module-webnotes.multi_tenant.setup"><tt class="docutils literal"><span class="pre">setup</span></tt> Module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="webnotes.utils.html">utils Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#id1"><tt class="docutils literal"><span class="pre">utils</span></tt> Package</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#archive-module"><tt class="docutils literal"><span class="pre">archive</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#backups-module"><tt class="docutils literal"><span class="pre">backups</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.cache"><tt class="docutils literal"><span class="pre">cache</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.encrypt"><tt class="docutils literal"><span class="pre">encrypt</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.file_manager"><tt class="docutils literal"><span class="pre">file_manager</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.jsmin"><tt class="docutils literal"><span class="pre">jsmin</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.nestedset"><tt class="docutils literal"><span class="pre">nestedset</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.scheduler"><tt class="docutils literal"><span class="pre">scheduler</span></tt> Module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="webnotes.utils.html#to-install">To install:</a></li>
<li class="toctree-l5"><a class="reference internal" href="webnotes.utils.html#in-cron">In cron:</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.sitemap"><tt class="docutils literal"><span class="pre">sitemap</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.transfer"><tt class="docutils literal"><span class="pre">transfer</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.webservice"><tt class="docutils literal"><span class="pre">webservice</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="webnotes.utils.email_lib.html">email_lib Package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#id1"><tt class="docutils literal"><span class="pre">email_lib</span></tt> Package</a></li>
<li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.form_email"><tt class="docutils literal"><span class="pre">form_email</span></tt> Module</a></li>
<li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.html2text"><tt class="docutils literal"><span class="pre">html2text</span></tt> Module</a></li>
<li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.receive"><tt class="docutils literal"><span class="pre">receive</span></tt> Module</a></li>
<li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.send"><tt class="docutils literal"><span class="pre">send</span></tt> Module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="webnotes.widgets.html">widgets Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.auto_master"><tt class="docutils literal"><span class="pre">auto_master</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.event"><tt class="docutils literal"><span class="pre">event</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.follow"><tt class="docutils literal"><span class="pre">follow</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.form"><tt class="docutils literal"><span class="pre">form</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.menus"><tt class="docutils literal"><span class="pre">menus</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.page"><tt class="docutils literal"><span class="pre">page</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.page_body"><tt class="docutils literal"><span class="pre">page_body</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.query_builder"><tt class="docutils literal"><span class="pre">query_builder</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.search"><tt class="docutils literal"><span class="pre">search</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.tags"><tt class="docutils literal"><span class="pre">tags</span></tt> Module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.todo"><tt class="docutils literal"><span class="pre">todo</span></tt> Module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>
            </a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/modules.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" size="18" />
      <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><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
  </body>
</html>