Event driven concurrent framework for Python
.. image:: https://fluidily-public.s3.amazonaws.com/pulsar/images/pulsar-banner-600.svg :alt: Pulsar :width: 300
| |
:Badges: |license| |pyversions| |status| |pypiversion| |contributors|
:CI: |circleci| |coverage| |appveyor| |travis| |docs|
:Documentation: https://docs.pulsarweb.org
:Downloads: http://pypi.python.org/pypi/pulsar
:Source: https://github.com/quantmind/pulsar
:Benchmarks: https://bench.pulsarweb.org/
:Chat channel: Riot.im room
_
:Mailing list: google user group
_
:Stack overflow: questions tagged python-pulsar_
:Design by: Quantmind
_ and Luca Sbardella
_
:Platforms: Linux, OSX, Windows. Python 3.5 and above
:Keywords: python, asyncio, multiprocessing, client/server, asynchronous, concurrency, actor, thread, process, socket, wsgi, websocket, redis, json-rpc
.. |pypiversion| image:: https://img.shields.io/pypi/v/pulsar.svg :target: https://pypi.python.org/pypi/pulsar .. |pyversions| image:: https://img.shields.io/pypi/pyversions/pulsar.svg :target: https://pypi.python.org/pypi/pulsar .. |license| image:: https://img.shields.io/pypi/l/pulsar.svg :target: https://pypi.python.org/pypi/pulsar .. |status| image:: https://img.shields.io/pypi/status/pulsar.svg :target: https://pypi.python.org/pypi/pulsar .. |downloads| image:: https://img.shields.io/pypi/dd/pulsar.svg :target: https://pypi.python.org/pypi/pulsar .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/w2ip01j07qm161ei?svg=true :target: https://ci.appveyor.com/project/lsbardel/pulsar .. |contributors| image:: https://img.shields.io/github/contributors/quantmind/pulsar.svg :target: https://github.com/quantmind/pulsar/graphs/contributors .. |circleci| image:: https://circleci.com/gh/quantmind/pulsar.svg?style=svg :target: https://circleci.com/gh/quantmind/pulsar .. |coverage| image:: https://codecov.io/gh/quantmind/pulsar/branch/master/graph/badge.svg :target: https://codecov.io/gh/quantmind/pulsar .. |travis| image:: https://api.travis-ci.org/quantmind/pulsar.svg?branch=release :target: https://travis-ci.org/quantmind/pulsar .. |docs| image:: https://media.readthedocs.org/static/projects/badges/passing.svg :target: https://docs.pulsarweb.org
An example of a web server written with pulsar
which responds with
"Hello World!" for every request:
.. code:: python
from pulsar.apps import wsgi
def hello(environ, start_response):
data = b'Hello World!\n'
response_headers = [
('Content-type','text/plain'),
('Content-Length', str(len(data)))
]
start_response('200 OK', response_headers)
return [data]
if __name__ == '__main__':
wsgi.WSGIServer(callable=hello).start()
Pulsar's goal is to provide an easy way to build scalable network programs.
In the Hello world!
web server example above, many client
connections can be handled concurrently.
Pulsar tells the operating system (through epoll or select) that it should be
notified when a new connection is made, and then it goes to sleep.
Pulsar uses the asyncio_ module from the standard python library and it can be configured to run in multi-processing mode.
Another example of pulsar framework is the asynchronous HttpClient_:
.. code:: python
from pulsar.apps import http
async with http.HttpClient() as session:
response1 = await session.get('https://github.com/timeline.json')
response2 = await session.get('https://api.github.com/emojis.json')
The http client maintains connections alive (by default 15 seconds) and therefore
any requests that you make within a session will automatically reuse the
appropriate connection. All connections are released once the session exits the
asynchronous with
block.
Pulsar has one hard dependency:
install via pip::
pip install pulsar
or download the tarball from pypi_.
To speedup pulsar by a factor of 2 or more these soft dependencies are recommended
Pulsar design allows for a host of different asynchronous applications to be implemented in an elegant and efficient way. Out of the box it is shipped with the the following:
Asynchronous WSGI server
_Web Sockets
_Asynchronous Test suite
_Data stores
_ (with async Redis client)Task queue consumers
_Asynchronous botocore
_django integration
_.. _examples:
Check out the examples
directory for various working applications.
It includes:
dining philosophers problem <http://en.wikipedia.org/wiki/Dining_philosophers_problem>
_.Twitter streaming <https://github.com/quantmind/pulsar-twitter>
_Pulsar internals are based on actors primitive
_. Actors
are the atoms
of pulsar's concurrent computation, they do not share state between them,
communication is achieved via asynchronous inter-process message passing,
implemented using the standard python socket library.
Two special classes of actors are the Arbiter
, used as a singleton_,
and the Monitor
, a manager of several actors performing similar functions.
The Arbiter runs the main eventloop and it controls the life of all actors.
Monitors manage group of actors performing similar functions, You can think
of them as a pool of actors.
.. image:: https://fluidily-public.s3.amazonaws.com/pulsar/images/actors.png :alt: Pulsar Actors
More information about design and philosophy in the documentation.
Pulsar checks if some additional libraries are available at runtime, and uses them to add additional functionalities or improve performance:
pulsar.apps.greenio
_ module and useful for
developing implicit asynchronous applications--io uv
in the command line (or event_loop="uv"
in the config file)system
key is available in the dictionary
returned by Actor info methodjson
moduleslugify
functionPulsar test suite uses the pulsar test application. To run tests::
python setup.py test
For options and help type::
python setup.py test --help
flake8_ check (requires flake8 package)::
flake8
.. _contributing:
Development of pulsar_ happens at Github. We very much welcome your contribution of course. To do so, simply follow these guidelines:
git checkout -b my_branch
git push origin my_branch
A good pull
request should:
tests
directory)flake8
tests pass.. _license:
This software is licensed under the BSD_ 3-clause License. See the LICENSE file in the top distribution directory for the full license text.
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _multiprocessing: http://docs.python.org/library/multiprocessing.html
.. _actors primitive
: http://en.wikipedia.org/wiki/Actor_model
.. _setproctitle: http://code.google.com/p/py-setproctitle/
.. _psutil: https://github.com/giampaolo/psutil
.. _pypi: http://pypi.python.org/pypi/pulsar
.. _BSD: http://opensource.org/licenses/BSD-3-Clause
.. _pulsar: https://github.com/quantmind/pulsar
.. _singleton: http://en.wikipedia.org/wiki/Singleton_pattern
.. _cython: http://cython.org/
.. _google user group
: https://groups.google.com/forum/?fromgroups#!forum/python-pulsar
.. _flake8: https://pypi.python.org/pypi/flake8
.. _ujson: https://pypi.python.org/pypi/ujson
.. _rebase: https://help.github.com/articles/about-git-rebase
.. _unidecode: https://pypi.python.org/pypi/Unidecode
.. _Luca Sbardella
: http://lucasbardella.com
.. _Quantmind
: http://quantmind.com
.. _JSON-RPC: http://www.jsonrpc.org/
.. _mcve: http://stackoverflow.com/help/mcve
.. _python-certifi: https://certifi.io
.. _greenlet: http://greenlet.readthedocs.io/
.. _pulsar.apps.greenio
: https://github.com/quantmind/pulsar/tree/master/pulsar/apps/greenio
.. _pulsar.apps.pulse
: https://github.com/quantmind/pulsar/tree/master/pulsar/apps/pulse
.. _HttpClient: http://quantmind.github.io/pulsar/apps/http.html
.. _Data stores
: http://quantmind.github.io/pulsar/apps/data/index.html
.. _Task queue consumers
: https://github.com/quantmind/pulsar-queue
.. _Asynchronous botocore
: https://github.com/quantmind/pulsar-cloud
.. _django integration
: https://github.com/quantmind/pulsar-django
.. _python-pulsar
: http://stackoverflow.com/questions/tagged/python-pulsar
.. _Web Sockets
: http://quantmind.github.io/pulsar/apps/websockets.html
.. _uvloop: https://github.com/MagicStack/uvloop
.. _httptools: https://github.com/MagicStack/httptools
.. _multidict: https://github.com/aio-libs/multidict
.. _Asynchronous WSGI server
: http://quantmind.github.io/pulsar/apps/wsgi/index.html
.. _Asynchronous Test suite
: http://quantmind.github.io/pulsar/apps/test.html
.. _Riot.im room
: https://riot.im/app/#/room/#pulsar:matrix.org