PageRenderTime 8ms CodeModel.GetById 2ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

/README.rst

https://bitbucket.org/prologic/circuits/
ReStructuredText | 140 lines | 95 code | 45 blank | 0 comment | 0 complexity | daca0cc937bf05a78174982ccacf09fe MD5 | raw file
  1.. _Python Programming Language: http://www.python.org/
  2.. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4
  3.. _FreeNode IRC Network: http://freenode.net
  4.. _Python Standard Library: http://docs.python.org/library/
  5.. _MIT License: http://www.opensource.org/licenses/mit-license.php
  6.. _Create an Issue: https://bitbucket.org/circuits/circuits/issue/new
  7.. _Mailing List: http://groups.google.com/group/circuits-users
  8.. _Project Website: http://circuitsframework.com/
  9.. _PyPi Page: http://pypi.python.org/pypi/circuits
 10.. _Read the Docs: http://circuits.readthedocs.org/en/latest/
 11.. _View the ChangeLog: http://circuits.readthedocs.org/en/latest/changes.html
 12.. _Downloads Page: https://bitbucket.org/circuits/circuits/downloads
 13
 14
 15circuits is a **Lightweight** **Event** driven and **Asynchronous**
 16**Application Framework** for the `Python Programming Language`_
 17with a strong **Component** Architecture.
 18
 19circuits also includes a lightweight, high performance and scalable
 20HTTP/WSGI compliant web server as well as various I/O and Networking
 21components.
 22
 23- Visit the `Project Website`_
 24- `Read the Docs`_
 25- Download it from the `Downloads Page`_
 26- `View the ChangeLog`_
 27
 28.. image:: https://pypip.in/v/circuits/badge.png?text=version
 29   :target: https://pypi.python.org/pypi/circuits
 30   :alt: Latest Version
 31
 32.. image:: https://pypip.in/py_versions/circuits/badge.svg
 33   :target: https://pypi.python.org/pypi/circuits
 34   :alt: Supported Python Versions
 35
 36.. image:: https://pypip.in/implementation/circuits/badge.svg
 37   :target: https://pypi.python.org/pypi/circuits
 38   :alt: Supported Python implementations
 39
 40.. image:: https://pypip.in/status/circuits/badge.svg
 41   :target: https://pypi.python.org/pypi/circuits
 42   :alt: Development Status
 43
 44.. image:: https://pypip.in/d/circuits/badge.png
 45   :target: https://pypi.python.org/pypi/circuits
 46   :alt: Number of Downloads
 47
 48.. image:: https://pypip.in/format/circuits/badge.svg
 49   :target: https://pypi.python.org/pypi/circuits
 50   :alt: Format
 51
 52.. image:: https://pypip.in/license/circuits/badge.svg
 53   :target: https://pypi.python.org/pypi/circuits
 54   :alt: License
 55
 56.. image:: https://requires.io/bitbucket/circuits/circuits/requirements.png?branch=default
 57   :target: https://requires.io/bitbucket/circuits/circuits/requirements?branch=default
 58   :alt: Requirements Status
 59
 60
 61Examples
 62--------
 63
 64
 65.. include:: examples/index.rst
 66
 67
 68Features
 69--------
 70
 71- event driven
 72- concurrency support
 73- component architecture
 74- asynchronous I/O components
 75- no required external dependencies
 76- full featured web framework (circuits.web)
 77- coroutine based synchronization primitives
 78
 79
 80Requirements
 81------------
 82
 83- circuits has no dependencies beyond the `Python Standard Library`_.
 84
 85
 86Supported Platforms
 87-------------------
 88
 89- Linux, FreeBSD, Mac OS X, Windows
 90- Python 2.6, 2.7, 3.2, 3.3, 3.4
 91- pypy 2.0, 2.1, 2.2
 92
 93
 94Installation
 95------------
 96
 97The simplest and recommended way to install circuits is with pip.
 98You may install the latest stable release from PyPI with pip::
 99
100    > pip install circuits
101
102If you do not have pip, you may use easy_install::
103
104    > easy_install circuits
105
106Alternatively, you may download the source package from the
107`PyPi Page`_ or the `Downloads Page`_ extract it and install using::
108
109    > python setup.py install
110
111
112.. note::
113    You can install the `development version
114    <https://bitbucket.org/circuits/circuits/get/tip.tar.gz#egg=circuits-dev>`_
115    via ``pip install circuits==dev``.
116
117
118License
119-------
120
121circuits is licensed under the `MIT License`_.
122
123
124Feedback
125--------
126
127We welcome any questions or feedback about bugs and suggestions on how to
128improve circuits. Let us know what you think about circuits. `@pythoncircuits <http://twitter.com/pythoncircuits>`_.
129
130Do you have suggestions for improvement? Then please `Create an Issue`_
131with details of what you would like to see. I'll take a look at it and
132work with you to either incorporate the idea or find a better solution.
133
134
135Community
136---------
137
138There is also a small community of circuits enthusiasts that you may
139find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_
140and the `Mailing List`_.