Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Extended JWT integration with Flask

Project description

Flask-JWT-Extended

Build Status Coverage Status PyPI version Documentation Status Join the chat at https://gitter.im/flask-jwt-extended/Lobby

When to use Flask-JWT-Extended?

Flask-JWT-Extended not only adds support for using JSON Web Tokens (JWT) to Flask for protecting views, but also many helpful (and optional) features built in to make working with JSON Web Tokens easier. These include:

  • Support for adding custom claims to JSON Web Tokens
  • Custom claims validation on received tokens
  • Creating tokens from complex objects or complex object from received tokens
  • Refresh tokens
  • Token freshness and separate view decorators to only allow fresh tokens
  • Token revoking/blacklisting
  • Storing tokens in cookies and CSRF protection

When not to use Flask-JWT-Extended?

This extension is very opinionated about what claims need to exist in received JWTs to get all these extra features to work. If you are working with other JWT providers, only using Flask for rapid prototyping of your application, or do not care about any of these extra features, Flask-JWT-Simple may be a better fit for your application. It is the sister extension of this one (both maintained by me), which strips all of the extra features and opinionated JWT requirements out.

Upgrading to the 3.x.x releases

See here for help upgrading to the 3.x.x releases.

Installation

View Installation Instructions

Usage

View the documentation online

Chatting

We have moved from irc to gitter. The official support channel can now be found at https://gitter.im/flask-jwt-extended/Lobby.

Testing and Code Coverage

We require 100% code coverage in our unit tests. You can run the tests locally with tox which will print out a code coverage report. Creating a pull request will run the tests against python 2.7, 3.4, 3.5, 3.6, and PyPy.

$ tox

Generating Documentation

You can generate a local copy of the documentation. After installing the requirements, go to the docs directory and run:

$ make clean && make html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Flask-JWT-Extended-3.13.1.tar.gz (28.5 kB) Copy SHA256 hash SHA256 Source None Sep 28, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page