aiohttp-security/README.rst

56 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2015-07-08 17:30:24 +00:00
aiohttp_security
================
2017-01-24 12:36:34 +00:00
.. image:: https://travis-ci.org/aio-libs/aiohttp-security.svg?branch=master
:target: https://travis-ci.org/aio-libs/aiohttp-security
.. image:: https://codecov.io/github/aio-libs/aiohttp-security/coverage.svg?branch=master
:target: https://codecov.io/github/aio-libs/aiohttp-security
2017-01-24 22:51:02 +00:00
.. image:: https://readthedocs.org/projects/aiohttp-security/badge/?version=latest
:target: https://aiohttp-security.readthedocs.io/
2017-01-25 11:29:57 +00:00
.. image:: https://img.shields.io/pypi/v/aiohttp-security.svg
:target: https://pypi.python.org/pypi/aiohttp-security
2015-07-08 17:30:24 +00:00
The library provides identity and authorization for `aiohttp.web`__.
2015-07-08 17:30:24 +00:00
.. _aiohttp_web: http://aiohttp.readthedocs.org/en/latest/web.html
__ aiohttp_web_
Installation
------------
Simplest case (authorization via cookies) ::
$ pip install aiohttp_security
With `aiohttp-session` support ::
$ pip install aiohttp_security[session]
Examples
--------
Take a look at examples:
2018-03-06 12:21:40 +00:00
`Basic example`_
2018-03-06 12:21:40 +00:00
`Example with DB auth`_
.. _`Basic example`: docs/example.rst
.. _`Example with db auth`: docs/example_db_auth.rst
and demos at **demo** directory.
2017-01-24 00:31:06 +00:00
Documentation
-------------
https://aiohttp-security.readthedocs.io/
Develop
-------
2018-04-06 18:29:38 +00:00
``pip install -r requirements-dev.txt``
2015-07-08 17:30:24 +00:00
License
-------
``aiohttp_security`` is offered under the Apache 2 license.