index.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>BeeWatch &mdash; BeeWatch unreleased documentation</title>
  8. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  9. <link rel="index" title="Index"
  10. href="../genindex.html"/>
  11. <link rel="search" title="Search" href="../search.html"/>
  12. <link rel="top" title="BeeWatch unreleased documentation" href="../index.html"/>
  13. <link rel="next" title="Program Design" href="../design.html"/>
  14. <link rel="prev" title="Template" href="../getting_started.html"/>
  15. <script src="../_static/js/modernizr.min.js"></script>
  16. </head>
  17. <body class="wy-body-for-nav" role="document">
  18. <div class="wy-grid-for-nav">
  19. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  20. <div class="wy-side-scroll">
  21. <div class="wy-side-nav-search">
  22. <a href="../index.html" class="icon icon-home"> BeeWatch
  23. </a>
  24. <div class="version">
  25. unreleased
  26. </div>
  27. <div role="search">
  28. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  29. <input type="text" name="q" placeholder="Search docs" />
  30. <input type="hidden" name="check_keywords" value="yes" />
  31. <input type="hidden" name="area" value="default" />
  32. </form>
  33. </div>
  34. </div>
  35. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  36. <p class="caption"><span class="caption-text">Contents:</span></p>
  37. <ul class="current">
  38. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Template</a></li>
  39. <li class="toctree-l1 current"><a class="current reference internal" href="#">BeeWatch</a><ul>
  40. <li class="toctree-l2"><a class="reference internal" href="../design.html">Program Design</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="gui/index.html">Template</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="server/index.html">Template</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="pinapi/index.html">Template</a></li>
  44. </ul>
  45. </li>
  46. <li class="toctree-l1"><a class="reference internal" href="../configure.html">HowTo Configuration!</a></li>
  47. </ul>
  48. </div>
  49. </div>
  50. </nav>
  51. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  52. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  53. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  54. <a href="../index.html">BeeWatch</a>
  55. </nav>
  56. <div class="wy-nav-content">
  57. <div class="rst-content">
  58. <div role="navigation" aria-label="breadcrumbs navigation">
  59. <ul class="wy-breadcrumbs">
  60. <li><a href="../index.html">Docs</a> &raquo;</li>
  61. <li>BeeWatch</li>
  62. <li class="wy-breadcrumbs-aside">
  63. <a href="../_sources/beewatch/index.rst.txt" rel="nofollow"> View page source</a>
  64. </li>
  65. </ul>
  66. <hr/>
  67. </div>
  68. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  69. <div itemprop="articleBody">
  70. <div class="section" id="beewatch">
  71. <h1>BeeWatch<a class="headerlink" href="#beewatch" title="Permalink to this headline">¶</a></h1>
  72. <div class="admonition note">
  73. <p class="first admonition-title">Note</p>
  74. <p class="last">This documentation is in early development.</p>
  75. </div>
  76. <div class="toctree-wrapper compound">
  77. <p class="caption"><span class="caption-text">Contents:</span></p>
  78. <ul>
  79. <li class="toctree-l1"><a class="reference internal" href="../design.html">Program Design</a><ul class="simple">
  80. </ul>
  81. </li>
  82. <li class="toctree-l1"><a class="reference internal" href="gui/index.html">Template</a></li>
  83. <li class="toctree-l1"><a class="reference internal" href="server/index.html">Template</a></li>
  84. <li class="toctree-l1"><a class="reference internal" href="pinapi/index.html">Template</a></li>
  85. </ul>
  86. </div>
  87. <span class="target" id="module-beewatch"></span><p>DOCSTRING</p>
  88. <dl class="class">
  89. <dt id="beewatch.Configure">
  90. <em class="property">class </em><code class="descclassname">beewatch.</code><code class="descname">Configure</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#beewatch.Configure" title="Permalink to this definition">¶</a></dt>
  91. <dd><p>Configure BeeWatch from a dict</p>
  92. <p>This class is inspired by logging.config
  93. (<a class="reference external" href="https://github.com/python/cpython/blob/3.6/Lib/logging/config.py">https://github.com/python/cpython/blob/3.6/Lib/logging/config.py</a>)</p>
  94. <table class="docutils field-list" frame="void" rules="none">
  95. <col class="field-name" />
  96. <col class="field-body" />
  97. <tbody valign="top">
  98. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dictionary holding config information. for more information see <code class="xref any docutils literal"><span class="pre">/config/index</span></code></td>
  99. </tr>
  100. </tbody>
  101. </table>
  102. <dl class="method">
  103. <dt id="beewatch.Configure.configure">
  104. <code class="descname">configure</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#beewatch.Configure.configure" title="Permalink to this definition">¶</a></dt>
  105. <dd></dd></dl>
  106. <dl class="method">
  107. <dt id="beewatch.Configure.str_to_callable">
  108. <code class="descname">str_to_callable</code><span class="sig-paren">(</span><em>dotted_str</em><span class="sig-paren">)</span><a class="headerlink" href="#beewatch.Configure.str_to_callable" title="Permalink to this definition">¶</a></dt>
  109. <dd></dd></dl>
  110. <dl class="attribute">
  111. <dt id="beewatch.Configure.warnings">
  112. <code class="descname">warnings</code><em class="property"> = True</em><a class="headerlink" href="#beewatch.Configure.warnings" title="Permalink to this definition">¶</a></dt>
  113. <dd></dd></dl>
  114. </dd></dl>
  115. </div>
  116. </div>
  117. <div class="articleComments">
  118. </div>
  119. </div>
  120. <footer>
  121. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  122. <a href="../design.html" class="btn btn-neutral float-right" title="Program Design" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  123. <a href="../getting_started.html" class="btn btn-neutral" title="Template" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  124. </div>
  125. <hr/>
  126. <div role="contentinfo">
  127. <p>
  128. &copy; Copyright 2017, Digital.
  129. </p>
  130. </div>
  131. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  132. </footer>
  133. </div>
  134. </div>
  135. </section>
  136. </div>
  137. <script type="text/javascript">
  138. var DOCUMENTATION_OPTIONS = {
  139. URL_ROOT:'../',
  140. VERSION:'unreleased',
  141. COLLAPSE_INDEX:false,
  142. FILE_SUFFIX:'.html',
  143. HAS_SOURCE: true,
  144. SOURCELINK_SUFFIX: '.txt'
  145. };
  146. </script>
  147. <script type="text/javascript" src="../_static/jquery.js"></script>
  148. <script type="text/javascript" src="../_static/underscore.js"></script>
  149. <script type="text/javascript" src="../_static/doctools.js"></script>
  150. <script type="text/javascript" src="../_static/js/theme.js"></script>
  151. <script type="text/javascript">
  152. jQuery(function () {
  153. SphinxRtdTheme.StickyNav.enable();
  154. });
  155. </script>
  156. </body>
  157. </html>