/usr/share/doc/python-circuits-doc/html/index.html is in python-circuits-doc 2.1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | <!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>circuits 2.1.0 Documentation — circuits 2.1.0 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: '2.1.0',
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="circuits 2.1.0 documentation" href="#" />
<link rel="next" title="Getting Started" href="start/index.html" />
<script type="text/javascript" src=""></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body>
<div class="document">
<div id="custom-doc" class="">
<div id="hd">
<h1><a href="#">circuits 2.1.0 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="#">Home</a> |
<a title="Global index" href="genindex.html">Index</a> |
<a title="Module index" href="py-modindex.html">Modules</a>
</div>
<div class="nav">
<a title="circuits 2.1.0 documentation" href="#" accesskey="U">up</a>
|
<a href="start/index.html" title="Getting Started">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="index">
<div class="section" id="circuits-version-documentation">
<h1>circuits 2.1.0 Documentation<a class="headerlink" href="#circuits-version-documentation" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Release:</th><td class="field-body">2.1.0</td>
</tr>
<tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">July 11, 2013</td>
</tr>
</tbody>
</table>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>circuits is a <strong>Lightweight</strong> <strong>Event</strong> driven and <strong>Asynchronous</strong>
<strong>Application Framework</strong> for the <a class="reference external" href="http://www.python.org/">Python Programming Language</a>
with a strong <strong>Component</strong> Architecture.</p>
<p>circuits also includes a lightweight, high performance and scalable
HTTP/WSGI compliant web server as well as various I/O and Networking
components.</p>
<p>To take full advantage of circuits and its architecture, circuits
encourages you to design your application in terms of loosely coupled
components. Circuits has a very powerful message passing system that
enables components to interact with each other via events. Applications
written this way tend to be more maintainable, easier to develop and
scale to complex systems.</p>
<p>circuits’ <strong>Loosely Coupled</strong> <strong>Component Architecture</strong> allows for a
high level of <strong>Reuse</strong> and <strong>Scalability</strong>. Simpler components can be
combined together to form Complex Components and provide higher level
functionality and abstraction. Much of the circuits component library is
designed and built this way.</p>
<ul class="simple">
<li><strong>Documentation</strong>: <a class="reference external" href="http://packages.python.org/circuits">http://packages.python.org/circuits</a> or <a class="reference external" href="http://circuits.readthedocs.org/">Read the Docs</a>.</li>
<li><strong>Project website</strong>: <a class="reference external" href="https://bitbucket.org/prologic/circuits/">https://bitbucket.org/prologic/circuits/</a></li>
<li><strong>PyPI page</strong>: <a class="reference external" href="http://pypi.python.org/pypi/circuits">http://pypi.python.org/pypi/circuits</a></li>
</ul>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>event driven</li>
<li>concurrency support</li>
<li>component architecture</li>
<li>asynchronous I/O components</li>
<li>no required external dependencies</li>
<li>full featured web framework (circuits.web)</li>
<li>coroutine based synchronization primitives</li>
</ul>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>circuits has no dependencies beyond the <a class="reference external" href="http://docs.python.org/library/">Python Standard Library</a>.</li>
</ul>
</div>
<div class="section" id="supported-platforms">
<h2>Supported Platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Linux, FreeBSD, Mac OS X</li>
<li>Python 2.6, 2.7, 3.2, 3.3</li>
<li>pypy 2.0</li>
</ul>
<dl class="docutils">
<dt><strong>Windows</strong>: We acknowledge that Windows exists and make reasonable efforts</dt>
<dd>to maintain compatibility. Unfortunately we cannot guarantee
support at this time.</dd>
</dl>
<p><strong>NB</strong>: We are working toward getting Windows supported.</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>The simplest and recommended way to install circuits is with pip.
You may install the latest stable release from PyPI with pip:</p>
<div class="highlight-python"><pre>> pip install circuits</pre>
</div>
<p>If you do not have pip, you may use easy_install:</p>
<div class="highlight-python"><pre>> easy_install circuits</pre>
</div>
<p>Alternatively, you may download the source package from the
<a class="reference external" href="http://pypi.python.org/pypi/circuits">PyPi Page</a> or the <a class="reference external" href="https://bitbucket.org/prologic/circuits/downloads">Downloads page</a> on the
<a class="reference external" href="https://bitbucket.org/prologic/circuits/">Website</a>; extract it and install using:</p>
<div class="highlight-python"><pre>> python setup.py install</pre>
</div>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>circuits is licensed under the <a class="reference external" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a>.</p>
</div>
<div class="section" id="feedback">
<h2>Feedback<a class="headerlink" href="#feedback" title="Permalink to this headline">¶</a></h2>
<p>We welcome any questions or feedback about bugs and suggestions on how to
improve circuits. Let us know what you think about circuits. <a class="reference external" href="http://twitter.com/pythoncircuits">@pythoncircuits</a>.</p>
<p>Do you have suggestions for improvement? Then please <a class="reference external" href="https://bitbucket.org/prologic/circuits/issue/new">Create an Issue</a>
with details of what you would like to see. I’ll take a look at it and
work with you to either incorporate the idea or find a better solution.</p>
</div>
<div class="section" id="community">
<h2>Community<a class="headerlink" href="#community" title="Permalink to this headline">¶</a></h2>
<p>There is also a small community of circuits enthusiasts that you may
find on the <a class="reference external" href="http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4">#circuits IRC Channel</a> on the <a class="reference external" href="http://freenode.net">FreeNode IRC Network</a>
and the <a class="reference external" href="http://groups.google.com/group/circuits-users">Mailing List</a>.</p>
<script type="text/javascript" src="http://www.ohloh.net/p/587962/widgets/project_thin_badge.js"></script><div class="section" id="contents">
<h3>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="start/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="man/index.html">The circuits Framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/index.html">The circuits.web Framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="howtos/index.html">HowTos</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Developer Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">ChangeLog</a></li>
<li class="toctree-l1"><a class="reference internal" href="users.html">Users</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="indices-and-tables">
<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h3>
<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>
<li><a class="reference internal" href="glossary.html"><em>Glossary</em></a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="ft">
<div class="nav">
<a title="circuits 2.1.0 documentation" href="#" accesskey="U">up</a>
|
<a href="start/index.html" title="Getting Started">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
|