Aiopyramid
==========

A library for leveraging pyramid infrastructure asynchronously using the new :mod:`asyncio`.

``Aiopyramid`` provides tools for making web applications with :ref:`Pyramid <pyramid:index>` and :mod:`asyncio`.
It will not necessarily make your application run faster. Instead, it gives you some tools
and patterns to build an application on asynchronous servers that handle many active connections.

This is not a fork of :ref:`Pyramid <pyramid:index>` and it does not rewrite
any :ref:`Pyramid <pyramid:index>` code to run asynchronously!
:ref:`Pyramid <pyramid:index>` is just that flexible.

Getting Started
---------------

``Aiopyramid`` includes a scaffold that creates a "hello world" application,
check it out! The scaffold is designed to work with either `gunicorn`_
via a custom worker or `uWSGI`_ via the `uWSGI asyncio plugin`_.

For example:

::

    pip install aiopyramid gunicorn
    pcreate -s aio_starter <project>
    cd <project>
    python setup.py develop
    gunicorn --paste development.ini

There is also a :term:`websocket` scaffold `aio_websocket` with basic tools for setting up
a :term:`websocket` server.

For a more detailed walkthrough of how to setup ``Aiopyramid`` see the :doc:`tutorial`.


Contents
--------

.. toctree::
    :maxdepth: 3

    features
    tutorial
    approach
    tests
    Index <tables>


Contributors
------------

- Jason Housley
- Guillaume Gauvrit
- Tiago Requeijo
- Ander Ustarroz
- Ramon Navarro Bosch
- Rickert Mulder

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :doc:`glossary`

.. _gunicorn: http://gunicorn.org
.. _uWSGI: https://github.com/unbit/uwsgi
.. _uWSGI asyncio plugin: http://uwsgi-docs.readthedocs.org/en/latest/asyncio.html