api_hour 0.8.2
Write efficient network daemons (HTTP, SSH...) with ease.
License: Apache 2
Keywords: asyncio

API Hour
========

API-Hour is a lightweight daemon framework, that lets you write powerful applications.

It was created to answer the need for a simple, robust, and super-fast server-side environment to build very efficient Daemons with ease.

By default, API-Hour Starter Kit (Cookiecutter) creates for you a HTTP daemon to develop WebServices.

With API-Hour, you can quickly convert any AsyncIO server library to multi-processing daemon, ready for production.

.. image:: https://raw.githubusercontent.com/Eyepea/API-Hour/master/docs/API-Hour_small.png

Quick'n'dirty HTTP benchmarks on a kitchen table
------------------------------------------------

.. image:: https://raw.githubusercontent.com/Eyepea/API-Hour/master/propaganda/en/stats.png

Scale: Number of queries during 30 seconds with 400 simultaneous connexions.

Benchmark made on a Dell Precision M6800 between API-Hour and Gunicorn with 16 workers.

For details, read information in `benchmarks <https://github.com/Eyepea/API-Hour/tree/master/benchmarks>`_.

Where is the magic to have theses performances ?
''''''''''''''''''''''''''''''''''''''''''''''''

Architecture matters a lot more that tools.

We use asynchronous and multiprocess patterns, combined together, to handle as much as possible HTTP requests.

Ideally, the limitation should be your network card, not your CPU nor memory.

Moreover, we've tried to reduce as much as possible layers between your code and async sockets.

For each layer, we use the best in term of performance and simplicity:

#. `AsyncIO <https://docs.python.org/3/library/asyncio.html>`_: an easy asynchronous framework, directly integrated in Python 3.4+
#. `aiohttp.web <https://aiohttp.readthedocs.org/en/latest/web.html>`_: HTTP protocol implementation for AsyncIO + Web framework
#. `ujson <https://github.com/esnme/ultrajson#ultrajson>`_: fastest JSON serialization

Examples
--------

#. `API-Hour Starter Kit (Cookiecutter) <https://github.com/Eyepea/cookiecutter-API-Hour>`_
#. `API-Hour implementation of TechEmpower Web Framework Benchmarks <https://github.com/TechEmpower/FrameworkBenchmarks/tree/master/frameworks/Python/asyncio>`_
#. `HTTP+SSH Daemon <https://github.com/Eyepea/API-Hour/tree/master/examples/http_and_ssh>`_
#. `Quick'n'dirty benchmarks on a kitchen table <https://github.com/Eyepea/API-Hour/tree/master/benchmarks/api_hour/benchmarks>`_

How-to start an API-Hour project ?
----------------------------------

You can follow `one of our tutorials <https://pythonhosted.org/api_hour/tutorials/index.html>`_

Support
-------

* `Documentation <https://pythonhosted.org/api_hour/>`_.
* `Mailing-list <https://groups.google.com/d/forum/api-hour>`_

Requirements
------------

- Python 3.5+

Install
-------

Follow `official documentation <https://pythonhosted.org/api_hour/installation.html>`_.

License
-------

``API-Hour`` is offered under the Apache 2 license.

Architecture
------------

``API-Hour`` is a glue between your code and Gunicorn to launch your code in several process.

Origin
------

API-Hour was a fork of aiorest, now only based on Gunicorn for multiprocessing.

Thanks
------

Thanks to Gunicorn, aiorest, aiohttp and AsyncIO community, they made 99,9999% of the job for API-Hour.

Special thanks to **Andrew Svetlov**, the creator of aiorest.

Goals of API-Hour
-----------------

#. **Fast**: API-Hour is designed from bottom-up to be extremely fast, and capable of handling a huge load. It uses Python 3 and its new powerful AsyncIO package.
#. **Scalable**: API-Hour is built to be elastic, and easily scalable.
#. **Lightweight**:
    #. **small codebase**: Doing less means being faster: the codebase for processing an request is kept as small as possible. Beyond this base foot-print, you can of course activate, preload and initialize more plugins or packages , but that choice is yours.
    #. **flexible setup**: Some people have no problems with using many dependencies, while others want to have none (other than Python). Some people are ok to loose a bit on performance, for the ease (and speed) of coding, while others wouldn't sacrifice a millisecond  for ready-made functionality. These choices are yours, so there are no mandatory extra layer, plugin or middleware.
#. **Easy**: API-Hour is meant to be very easy to grasp: No steep learning curve, no mountain of docs to read: Download our turn-key "Hello-world" applications, and immediately start coding your own application from there.
#. **Packages-friendly and friendly-packages**: We try to let you use external packages without the need to re-write them, adapt them,  " wrap " them or embed them in the framework. On the other hand, API-Hour " plugins " are written as much as possible to be usable as stand-alone packages outside the framework, to benefit to more people.
#. **Asynchronous... or not**: If you don't need the extra complexity of building asynchronous code, you don't have to (you'll still enjoy tremendous performance). You can just handle your requests in a traditional synchronous way. On the other hand, if your project does IO or processing that could benefit from parallelizing tasks, the whole power of Async. IO, futures, coroutines and tasks is at your fingertips. All provided plugins (in particular, Database plugins) are Async-ready.

CHANGES
=======

0.8.2 (2017-11-10)
------------------

* Add pre_start coroutine
* Fix setup.py to check correctly minimal Python version. Thanks @romuald

0.8.1 (2016-07-08)
------------------

* Drop support of Python 3.3 and 3.4

0.7.1 (2016-07-08)
------------------

* Merge bugfix from https://github.com/KeepSafe/aiohttp/pull/879

0.7.0 (2015-05-04)
------------------

* Add HTML serializer plugin
* Add AsyncIO high level stream server support (Used by FastAGI implementation of Panoramisk)
* Now, you can use make_handler method to connect directly your handlers with your sockets for more flexibility

0.6.2 (2015-02-24)
------------------

* You can customize event loop used with make_event_loop() class method in Container

0.6.1 (2015-02-10)
------------------

* Release a new version because PyPI is bugged: 0.6.0 is broken on PyPI

0.6.0 (2015-01-13)
------------------

* API-Hour config file is now optional, use -ac to auto-configure your app
* Add Python 3.3 compatibility to use easily Python 3 directly from distributions package
* Add Debian/Ubuntu package
* ujson is now optional for aiohttp.web
* More documentation with tutorials: all-in-one and Starter Kit
* If api_hour CLI has no logging file, enable logging on console by default

0.5.0 (2015-01-07)
------------------

* Project reboot
* Change API-Hour main goal: API-Hour can now multiprocess all AsyncIO lib server, not only HTTP
* API-Hour is now based on Gunicorn
* Remove aiorest fork, recommend to use aiohttp.web for HTTP daemons in cookiecutter

0.3.3 (2014-12-19)
------------------

* Static files can be served automatically
* body and json_body and transport accessible in Request
* loop accessible in Application
* Asset Serializer accepts encoding
* cookiecutter available at https://github.com/Eyepea/cookiecutter-API-Hour
* Use of ujson
* Bugfixes

0.3.2 (2014-10-31)
------------------

* Refactoring and clean-up
* Publish benchmark server for API-Hour
* English version of PyCON-FR presentation about API-Hour
* Fix response.write_eof() to follow aiohttp changes (Thanks aiorest for the patch)

0.3.1 (2014-10-28)
------------------

* Rename multi_process to arbiter
* Improve Python packaging

0.3.0 (2014-10-26)
------------------

* First version of API-Hour, performance oriented version of aiorest
* cookiecutter template
* Serialization support
* replace json by ujson
* basic multiprocessing

0.2.4 (2014-09-12)
------------------

* Make loop keywork-only parameter in create_session_factory() function

0.2.3 (2014-08-28)
------------------

* Redis session switched from asyncio_redis to aioredis

0.2.2 (2014-08-15)
------------------

* Added Pyramid-like matchdict to request
  (see https://github.com/aio-libs/aiorest/pull/18)

* Return "400 Bad Request" for incorrect JSON body in POST/PUT methods

* README fixed

* Custom response status code
  (see https://github.com/aio-libs/aiorest/pull/23)


0.1.1 (2014-07-09)
------------------

* Switched to aiohttp v0.9.0


0.1.0 (2014-07-07)
------------------

* Basic REST API