.. image:: https://travis-ci.org/Bouke/django-two-factor-auth.svg?branch=master :alt: Build Status :target: https://travis-ci.org/Bouke/django-two-factor-auth
.. image:: https://github.com/Bouke/django-two-factor-auth/workflows/build/badge.svg?branch=master :alt: Build Status :target: https://github.com/Bouke/django-two-factor-auth/actions
.. image:: https://codecov.io/gh/Bouke/django-two-factor-auth/branch/master/graph/badge.svg :alt: Test Coverage :target: https://codecov.io/gh/Bouke/django-two-factor-auth
.. image:: https://badge.fury.io/py/django-two-factor-auth.svg :alt: PyPI :target: https://pypi.python.org/pypi/django-two-factor-auth
Complete Two-Factor Authentication for Django. Built on top of the one-time
password framework django-otp_ and Django's built-in authentication framework
django.contrib.auth for providing the easiest integration into most Django
projects. Inspired by the user experience of Google's Two-Step Authentication,
allowing users to authenticate through call, text messages (SMS), by using a
token generator app like Google Authenticator or a YubiKey_ hardware token
If you run into problems, please file an issue on GitHub, or contribute to the project by forking the repository and sending some pull requests. The package is translated into English, Dutch and other languages. Please contribute your own language using Transifex_.
Test drive this app through the online
example app, hosted by Heroku. It
demos most features except the Twilio integration. The example also includes
django-user-sessions_ for providing Django sessions with a foreign key to the
user. Although the package is optional, it improves account security control
Compatible with modern Django versions. At the moment of writing that's
including 2.2, and 3.0 on Python 3.5, 3.6, 3.7 and 3.8.
Documentation is available at
Refer to the
installation instructions_ in the documentation.
For general questions regarding this package, please hop over to Stack Overflow. If you think there is an issue with this package; check if the issue is already listed (either open or closed), and file an issue if it's not.
issue tracker_ on Github.
source code_ at Github.
This project aims for full code-coverage, this means that your code should be well-tested. Also test branches for hardened code. You can run the full test suite with::
Or run a specific test with::
make test TARGET=tests.tests.TwilioGatewayTest
For Python compatibility, tox_ is used. You can run the full test suite, covering all supported Python and Django version with::
The following actions are required to push a new version:
Update release notes
If any new translations strings were added, push the new source language to Transifex_. Make sure translators have sufficient time to translate those new strings::
python example/manage.py makemigrations two_factor git commit two_factor/migrations -m "Added migrations"
Package and upload::
bumpversion [major|minor|patch] git push && git push --tags python setup.py sdist bdist_wheel twine upload dist/*
Have a look at django-user-sessions_ for Django sessions with a foreign key to
the user. This package is also included in the online
The project is licensed under the MIT license.
example app: http://example-two-factor-auth.herokuapp.com
.. _django-otp: https://pypi.python.org/pypi/django-otp
.. _Transifex: https://www.transifex.com/projects/p/django-two-factor-auth/
.. _Twilio: http://www.twilio.com/
.. _Heroku: https://www.heroku.com
.. _django-user-sessions: https://pypi.python.org/pypi/django-user-sessions
.. _tox: https://testrun.org/tox/latest/
.. _issue tracker: https://github.com/Bouke/django-two-factor-auth/issues
.. _source code: https://github.com/Bouke/django-two-factor-auth
.. _readthedocs.org: http://django-two-factor-auth.readthedocs.org/
.. _Yubikey: https://www.yubico.com/products/yubikey-hardware/
Hynek's Sharing Your Labor of Love: PyPI Quick And Dirty: