stanleykimm / flask-jwt-extended

An open source Flask extension that provides JWT support (with batteries included)!

Flask-JWT-Extended

Features

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

Usage

View the documentation online

Changelog

You can view the changelog here. This project follows semantic versioning.

Chatting

Come chat with the community or ask questions at https://gitter.im/flask-jwt-extended/Lobby.

Local Development

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

We also require features to be well documented. After installing the requirements, you can generate a local copy of documentation by going to the docs directory and running:

$ make clean && make html