===================
PyAMS OAuth authentication package package
===================

.. contents::


What is PyAMS?
==============

PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications
and content management with the Pyramid framework.

**PyAMS** is actually mainly used to manage web sites through content management applications (CMS,
see PyAMS_content package), but many features are generic and can be used inside any kind of web
application.

All PyAMS documentation is available on `ReadTheDocs <https://pyams.readthedocs.io>`_; source code
is available on `Gitlab <https://gitlab.com/pyams>`_ and pushed to `Github
<https://github.com/py-ams>`_. Doctests are available in *doctests* source folder.


What is PyAMS OAuth authentication package?
===========================================

This package is a plug-in for PyAMS security policy; it allows to authenticate application
users via an OAuth or OAuth2 authentication providers.

You have to include this package in your Pyramid configuration to activate this plug-in, but also
to register providers for which you want to allow access from.