.. image:: https://github.com/valohai/django-allauth-2fa/actions/workflows/ci.yml/badge.svg :target: https://github.com/valohai/django-allauth-2fa/actions/workflows/ci.yml
.. image:: https://codecov.io/gh/valohai/django-allauth-2fa/branch/main/graph/badge.svg :target: https://codecov.io/gh/valohai/django-allauth-2fa
.. image:: https://readthedocs.org/projects/django-allauth-2fa/badge/?version=latest :target: https://django-allauth-2fa.readthedocs.io/
django-allauth-2fa adds two-factor authentication
to django-allauth
.
django-allauth is a set of Django
_ applications which help with
authentication, registration, and other account management tasks.
Source code http://github.com/percipient/django-allauth-2fa Documentation https://django-allauth-2fa.readthedocs.io/
.. _two-factor authentication: https://en.wikipedia.org/wiki/Multi-factor_authentication .. _django-allauth: https://github.com/pennersr/django-allauth .. _Django: https://www.djangoproject.com/
two-factor authentication
views and workflow to django-allauth
.django-allauth-2fa attempts to maintain compatibility with supported versions of Django, django-allauth, and django-otp.
Current versions supported together is:
======== ============== ============== ======================== Django django-allauth django-otp Python ======== ============== ============== ======================== 4.1 0.53.0 1.2 3.8, 3.9, 3.10, 3.11 4.2 0.53.0 1.2 3.8, 3.9, 3.10, 3.11 ======== ============== ============== ========================
django-allauth-2fa was initially created by
Víðir Valberg Guðmundsson (@valberg)
, was maintained by
Percipient Networks
for many years, and is now maintained by
Valohai
_. Please feel free to contribute if you find
django-allauth-2fa useful!
around a feature idea or a bug.
feel free to email support@percipientnetworks.com and we will happily help you.
the repository
_ on GitHub to start making your changes to themain branch (or branch off of it).
works as expected.
published.
Start contributing '''''''''''''''''' Start by cloning the project with:
.. code-block:: bash
git clone https://github.com/valohai/django-allauth-2fa.git
The project uses hatch
_ for building and package management.
If you don't have hatch installed, you can do so by running:
.. code-block:: bash
pip install hatch
Setup you virtual environment with hatch:
.. code-block:: bash
hatch env create
Running tests '''''''''''''
Tests can be run using pytest <https://docs.pytest.org/en/6.2.x/>
_
.. code-block:: bash
hatch run pytest
Running the test project ''''''''''''''''''''''''
The test project can also be used as a minimal example using the following:
.. code-block:: bash
hatch run python manage.py migrate
hatch run python manage.py runserver
.. _Víðir Valberg Guðmundsson (@valberg): https://github.com/valberg .. _Percipient Networks: https://www.strongarm.io .. _Valohai: https://valohai.com/ .. _the repository: http://github.com/valohai/django-allauth-2fa .. _hatch: https://hatch.pypa.io/