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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
Metadata-Version: 1.1
Name: circuits
Version: 3.1.0
Summary: Asynchronous Component based Event Application Framework
Home-page: http://circuitsframework.com/
Author: James Mills
Author-email: prologic@shortcircuit.net.au
License: MIT
Download-URL: http://bitbucket.org/circuits/circuits/downloads/
Description: .. _Python Programming Language: http://www.python.org/
.. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4
.. _FreeNode IRC Network: http://freenode.net
.. _Python Standard Library: http://docs.python.org/library/
.. _MIT License: http://www.opensource.org/licenses/mit-license.php
.. _Create an Issue: https://bitbucket.org/circuits/circuits/issue/new
.. _Mailing List: http://groups.google.com/group/circuits-users
.. _Project Website: http://circuitsframework.com/
.. _PyPi Page: http://pypi.python.org/pypi/circuits
.. _Read the Docs: http://circuits.readthedocs.org/en/latest/
.. _View the ChangeLog: http://circuits.readthedocs.org/en/latest/changes.html
.. _Downloads Page: https://bitbucket.org/circuits/circuits/downloads
circuits is a **Lightweight** **Event** driven and **Asynchronous**
**Application Framework** for the `Python Programming Language`_
with a strong **Component** Architecture.
circuits also includes a lightweight, high performance and scalable
HTTP/WSGI compliant web server as well as various I/O and Networking
components.
- Visit the `Project Website`_
- `Read the Docs`_
- Download it from the `Downloads Page`_
- `View the ChangeLog`_
.. image:: https://pypip.in/v/circuits/badge.png?text=version
:target: https://pypi.python.org/pypi/circuits
:alt: Latest Version
.. image:: https://pypip.in/py_versions/circuits/badge.svg
:target: https://pypi.python.org/pypi/circuits
:alt: Supported Python Versions
.. image:: https://pypip.in/implementation/circuits/badge.svg
:target: https://pypi.python.org/pypi/circuits
:alt: Supported Python implementations
.. image:: https://pypip.in/status/circuits/badge.svg
:target: https://pypi.python.org/pypi/circuits
:alt: Development Status
.. image:: https://pypip.in/d/circuits/badge.png
:target: https://pypi.python.org/pypi/circuits
:alt: Number of Downloads
.. image:: https://pypip.in/format/circuits/badge.svg
:target: https://pypi.python.org/pypi/circuits
:alt: Format
.. image:: https://pypip.in/license/circuits/badge.svg
:target: https://pypi.python.org/pypi/circuits
:alt: License
.. image:: https://requires.io/bitbucket/circuits/circuits/requirements.png?branch=default
:target: https://requires.io/bitbucket/circuits/circuits/requirements?branch=default
:alt: Requirements Status
Examples
--------
Hello
.....
.. code:: python
#!/usr/bin/env python
"""circuits Hello World"""
from circuits import Component, Event
class hello(Event):
"""hello Event"""
class App(Component):
def hello(self):
"""Hello Event Handler"""
print("Hello World!")
def started(self, component):
"""Started Event Handler
This is fired internally when your application starts up and can be used to
trigger events that only occur once during startup.
"""
self.fire(hello()) # Fire hello Event
raise SystemExit(0) # Terminate the Application
App().run()
Echo Server
...........
.. code:: python
#!/usr/bin/env python
"""Simple TCP Echo Server
This example shows how you can create a simple TCP Server (an Echo Service)
utilizing the builtin Socket Components that the circuits library ships with.
"""
from circuits import handler, Debugger
from circuits.net.sockets import TCPServer
class EchoServer(TCPServer):
@handler("read")
def on_read(self, sock, data):
"""Read Event Handler
This is fired by the underlying Socket Component when there has been
new data read from the connected client.
..note :: By simply returning, client/server socket components listen
to ValueChagned events (feedback) to determine if a handler
returned some data and fires a subsequent Write event with
the value returned.
"""
return data
# Start and "run" the system.
# Bind to port 0.0.0.0:9000
app = EchoServer(9000)
Debugger().register(app)
app.run()
Hello Web
.........
.. code:: python
#!/usr/bin/env python
from circuits.web import Server, Controller
class Root(Controller):
def index(self):
"""Index Request Handler
Controller(s) expose implicitly methods as request handlers.
Request Handlers can still be customized by using the ``@expose``
decorator. For example exposing as a different path.
"""
return "Hello World!"
app = Server(("0.0.0.0", 9000))
Root().register(app)
app.run()
More `examples <https://bitbucket.org/circuits/circuits/src/tip/examples/>`_...
Features
--------
- event driven
- concurrency support
- component architecture
- asynchronous I/O components
- no required external dependencies
- full featured web framework (circuits.web)
- coroutine based synchronization primitives
Requirements
------------
- circuits has no dependencies beyond the `Python Standard Library`_.
Supported Platforms
-------------------
- Linux, FreeBSD, Mac OS X, Windows
- Python 2.6, 2.7, 3.2, 3.3, 3.4
- pypy 2.0, 2.1, 2.2
Installation
------------
The simplest and recommended way to install circuits is with pip.
You may install the latest stable release from PyPI with pip::
> pip install circuits
If you do not have pip, you may use easy_install::
> easy_install circuits
Alternatively, you may download the source package from the
`PyPi Page`_ or the `Downloads Page`_ extract it and install using::
> python setup.py install
.. note::
You can install the `development version
<https://bitbucket.org/circuits/circuits/get/tip.tar.gz#egg=circuits-dev>`_
via ``pip install circuits==dev``.
License
-------
circuits is licensed under the `MIT License`_.
Feedback
--------
We welcome any questions or feedback about bugs and suggestions on how to
improve circuits. Let us know what you think about circuits. `@pythoncircuits <http://twitter.com/pythoncircuits>`_.
Do you have suggestions for improvement? Then please `Create an Issue`_
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.
Community
---------
There is also a small community of circuits enthusiasts that you may
find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_
and the `Mailing List`_.
Keywords: event framework distributed concurrent component asynchronous
Platform: POSIX
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Environment :: Other Environment
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Adaptive Technologies
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Classifier: Topic :: Communications :: Email :: Mail Transport Agents
Classifier: Topic :: Database
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Clustering
Classifier: Topic :: System :: Distributed Computing
|
