Installation

Installing Flask-Security using:

pip install flask-security

will install the basic package along with its required dependencies:

  • Flask

  • Flask-Login

  • Flask-Principal

  • Flask-WTF

  • email-validator

  • itsdangerous

  • passlib

  • Blinker

These are not sufficient for a complete application - other packages are required based on features desired, password hash algorithms, storage backend, etc. Flask-Security has additional distribution ‘extras’ that can reduce the hassle of figuring out all the required packages. You can install these using the standard pip syntax:

pip install flask-security[extra1,extra2, ...]

Supported extras are:

  • babel - Translation services. It will install babel and Flask-Babel.

  • fsqla - Use flask-sqlalchemy and sqlalchemy as your storage interface.

  • common - Install Flask-Mailman, argon2 (the default password hash), and bleach.

  • mfa - Install packages used for multi-factor (two-factor, unified signin, WebAuthn): cryptography, qrcode, phonenumberslite (note that for SMS you still need to pick an SMS provider and install appropriate packages), and webauthn.

Your application will also need a database backend:

  • Sqlite is supported out of the box.

  • For PostgreSQL install psycopg2.

  • For MySQL install pymysql.

  • For MongoDB install Mongoengine.

For additional details on configuring your database engine connector - refer to sqlalchemy_engine