Source

mustachebox / docs / _build / html / index.html

Full commit


<!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>Welcome to mustachebox’s documentation! &mdash; mustachebox 0.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:     '0.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>
    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="top" title="mustachebox 0.1 documentation" href="#" />
    <link rel="next" title="Installation" href="installation.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="installation.html" title="Installation"
             accesskey="N">next</a> |</li>
        <li><a href="#">mustachebox 0.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="welcome-to-mustachebox-s-documentation">
<h1>Welcome to mustachebox&#8217;s documentation!<a class="headerlink" href="#welcome-to-mustachebox-s-documentation" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#cloning-the-repository">Cloning the repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#install-steps">Install Steps</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#testing">Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#create-the-backend">Create the Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#rendering">Rendering</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#add-the-templatetag">Add the templatetag</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#getting-the-json">Getting the json</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#playing-with-kwargs">Playing with kwargs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="graph_api.html">Graphs API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="chart/google.html">Google Chart</a></li>
<li class="toctree-l2"><a class="reference internal" href="chart/d3js.html">D3.js</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="backends.html">Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="templatetags.html">Template Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_data.html">Json Output</a></li>
</ul>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Mustache Box is a set of utilities to help you presenting graph of various data in a Django Project. Data can come from whatever source you want :</p>
<blockquote>
<div><ul class="simple">
<li>Distant API</li>
<li>Couchdb databases</li>
<li>Your Django models</li>
<li>...</li>
</ul>
</div></blockquote>
<div class="section" id="parts-architecture">
<h3>3 parts architecture<a class="headerlink" href="#parts-architecture" title="Permalink to this headline"></a></h3>
<p>To make a graph you will need 3 parts :</p>
<blockquote>
<div><ul class="simple">
<li>a method : the method lie in a Backend you create (or you can
use predefine ones). Each method is responsible for gathering
data (the way you want) and parse it to give a formated version
of the data to the template.</li>
<li>A template: the template is a classic HTML file made to hold
your graph. You can use some predefine template or use your
custom one</li>
<li>a javascript file : the javascript file take your data and
render a graph using the external dependencies you need (jquery,
d3js, raphaël, etc...)</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="features">
<h3>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h3>
<p>Of course there is serval features you gain with this architecture :</p>
<blockquote>
<div><ul class="simple">
<li>url auto-discovering : You do not have to design an url for each
method. Mustache Box take the pain away for you and design urls
for you. Of course, if you don&#8217;t like this feature, you can
design your own urls for each graphs.</li>
<li>request/ajax response : each url responds either to classic
request ( rendering a template with the data ) and to ajax
returning only the formated json suitable for javasccript
call. It has never be so easy to create long-pooling call.</li>
<li>reusability: mustachebow is made in a reusable fashion. You can
mix together your methods, javasccript files and html to present
different data with the same template and/or javascript, or
present the same data in different manners easily</li>
<li>templatetags: when you create a graph you can use it in a
templatetag too. It&#8217;s really easy to do. You just have to write
another template to hold your graph in the templatetag.</li>
</ul>
</div></blockquote>
<p>This software is released under GPLv3</p>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Welcome to mustachebox&#8217;s documentation!</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#parts-architecture">3 parts architecture</a></li>
<li><a class="reference internal" href="#features">Features</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="installation.html"
                        title="next chapter">Installation</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/index.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="installation.html" title="Installation"
             >next</a> |</li>
        <li><a href="#">mustachebox 0.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2013, Yohann Gabory.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>