Flask-User v1.0
===============

.. image:: https://travis-ci.org/lingthio/Flask-User.svg?branch=master
    :target: https://travis-ci.org/lingthio/Flask-User

.. image:: https://codecov.io/gh/lingthio/Flask-User/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/lingthio/Flask-User

.. image:: https://img.shields.io/pypi/v/Flask-User.svg
    :target: https://pypi.org/project/Flask-User

.. image:: https://img.shields.io/pypi/pyversions/Flask-User.svg
    :target: https://pypi.org/project/Flask-User

.. image:: https://img.shields.io/pypi/l/Flask-User?style=flat
    :target: https://pypi.org/project/Flask-User

| **Attention:**
| Flask-User v1.0 is a Production/Stable version.
| The previous version is `Flask-User v0.6 <http://flask-user.readthedocs.io/en/v0.6/>`_.


User Authentication and Management
----------------------------------
| So, you're writing a Flask web application and would like to authenticate your users.
| You start with a simple **Login** page, but soon enough you'll need to handle:

* **Registrations** and **Email Confirmations**
* **Change Usernames**, **Change Passwords**, and **Forgotten Passwords**

And wouldn't it be nice to also offer:

* **Added Security**
* **Increased Reliability**
* **Role-based Authorization**
* **Internationalization** (Chinese, Dutch, English, Farsi, Finnish, French, German, Italian, Polish, Russian, Slovak, Spanish, Swedish, Turkish and Ukrainian)


Customizable, yet Ready to use
------------------------------
* **Largely Configurable** -- By overriding configuration settings.
* **Fully Customizable** -- By overriding methods and properties.
* **Ready to use** -- Through sensible defaults.
* Supports **SQL** and **MongoDB** databases.


Well documented
---------------
- `Latest documentation <https://flask-user.readthedocs.io/en/latest/>`_
- `Flask-User v0.6 documentation <https://flask-user.readthedocs.io/en/v0.6/>`_
- `Flask-User v0.5 documentation <https://flask-user.readthedocs.io/en/v0.5/>`_

Additional features
-------------------
* **MIT License**
* **Tested** on Python 2.7, 3.4, 3.5, 3.6, 3.7 and 3.8. Coverage: Over 90%.
* **Event hooking** -- Through efficient signals.
* **Support for multiple emails per user**

Minimal Requirements
--------------------
- brypt 2.0+
- cryptography 1.6+
- Flask 0.9+
- Flask-Login 0.2+
- Flask-WTF 0.9+
- passlib 1.7+

Alternatives
------------
* `Flask-Login <https://flask-login.readthedocs.org/en/latest/>`_
* `Flask-Security <https://pythonhosted.org/Flask-Security/>`_

Authors
-------
| **Lead developer and Maintainer**
| Ling Thio -- https://github.com/lingthio
|
| **Collaborators and Maintainers**
| Andrey Semakin -- https://github.com/and-semakin
|
| **Contributors**
| `Many contributors <https://github.com/lingthio/Flask-User/graphs/contributors>`_

Contact us
----------
.. image:: http://img.shields.io/static/v1?label=Issues&message=Flask-User&logo=github
    :target: https://github.com/lingthio/Flask-User/issues

.. image:: https://badges.gitter.im/Flask-User/community.svg
    :target: https://gitter.im/Flask-User/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge

.. image:: http://img.shields.io/static/v1?label=Telegram&message=@flask_user&logo=telegram&color=blue
    :target: https://t.me/flask_user