Welcome to django-allauth-2fa!
==============================
.. 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/
Features
--------
* Adds `two-factor authentication`_ views and workflow to `django-allauth`_.
* Supports Authenticator apps via a QR code when enabling 2FA.
* Supports single-use back-up codes.
Compatibility
-------------
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
======== ============== ============== ========================
3.2 0.53.0 1.1 3.7, 3.8, 3.9, 3.10
4.0 0.53.0 1.1 3.8, 3.9, 3.10, 3.11
4.1 0.53.0 1.1 3.8, 3.9, 3.10, 3.11
4.2 0.53.0 1.1 3.8, 3.9, 3.10, 3.11
======== ============== ============== ========================
Contributing
------------
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!
#. Check for open issues or open a fresh issue to start a discussion
around a feature idea or a bug.
#. If you feel uncomfortable or uncertain about an issue or your changes,
feel free to email support@percipientnetworks.com and we will happily help you.
#. Fork `the repository`_ on GitHub to start making your changes to the
**main** branch (or branch off of it).
#. Write a test which shows that the bug was fixed or that the feature
works as expected.
#. Send a pull request and bug the maintainer until it gets merged and
published.
Running tests
'''''''''''''
Tests can be run using [pytest](https://docs.pytest.org/en/6.2.x/).
.. code-block:: bash
pip install -r requirements-test.txt
py.test
Running the test project
''''''''''''''''''''''''
The test project can also be used as a minimal example using the following:
.. code-block:: bash
# Migrate the SQLite database first.
DJANGO_SETTINGS_MODULE=tests.settings python manage.py migrate
# Run the server with debug.
DJANGO_SETTINGS_MODULE=tests.settings python manage.py runserver_plus
# Run the shell.
DJANGO_SETTINGS_MODULE=tests.settings python manage.py shell_plus
.. _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
Raw data
{
"_id": null,
"home_page": "",
"name": "django-allauth-2fa",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "2fa,allauth,auth,authentication,django,factor,otp,two",
"author": "",
"author_email": "V\u00ed\u00f0ir Valberg Gu\u00f0mundsson <valberg@orn.li>",
"download_url": "https://files.pythonhosted.org/packages/13/65/51b823ba7e844ceef7ac9f82e6130418fa0e616c38fe8041c012881139a4/django_allauth_2fa-0.11.1.tar.gz",
"platform": null,
"description": "Welcome to django-allauth-2fa!\n==============================\n\n.. image:: https://github.com/valohai/django-allauth-2fa/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/valohai/django-allauth-2fa/actions/workflows/ci.yml\n\n.. image:: https://codecov.io/gh/valohai/django-allauth-2fa/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/valohai/django-allauth-2fa\n\n.. image:: https://readthedocs.org/projects/django-allauth-2fa/badge/?version=latest\n :target: https://django-allauth-2fa.readthedocs.io/\n\ndjango-allauth-2fa adds `two-factor authentication`_ to `django-allauth`_.\ndjango-allauth is a set of `Django`_ applications which help with\nauthentication, registration, and other account management tasks.\n\nSource code\n http://github.com/percipient/django-allauth-2fa\nDocumentation\n https://django-allauth-2fa.readthedocs.io/\n\n.. _two-factor authentication: https://en.wikipedia.org/wiki/Multi-factor_authentication\n.. _django-allauth: https://github.com/pennersr/django-allauth\n.. _Django: https://www.djangoproject.com/\n\nFeatures\n--------\n\n* Adds `two-factor authentication`_ views and workflow to `django-allauth`_.\n* Supports Authenticator apps via a QR code when enabling 2FA.\n* Supports single-use back-up codes.\n\nCompatibility\n-------------\n\ndjango-allauth-2fa attempts to maintain compatibility with supported versions of\nDjango, django-allauth, and django-otp.\n\nCurrent versions supported together is:\n\n======== ============== ============== ========================\nDjango django-allauth django-otp Python\n======== ============== ============== ========================\n3.2 0.53.0 1.1 3.7, 3.8, 3.9, 3.10\n4.0 0.53.0 1.1 3.8, 3.9, 3.10, 3.11\n4.1 0.53.0 1.1 3.8, 3.9, 3.10, 3.11\n4.2 0.53.0 1.1 3.8, 3.9, 3.10, 3.11\n======== ============== ============== ========================\n\nContributing\n------------\n\ndjango-allauth-2fa was initially created by\n`V\u00ed\u00f0ir Valberg Gu\u00f0mundsson (@valberg)`_, was maintained by\n`Percipient Networks`_ for many years, and is now maintained by\n`Valohai`_. Please feel free to contribute if you find\ndjango-allauth-2fa useful!\n\n#. Check for open issues or open a fresh issue to start a discussion\n around a feature idea or a bug.\n#. If you feel uncomfortable or uncertain about an issue or your changes,\n feel free to email support@percipientnetworks.com and we will happily help you.\n#. Fork `the repository`_ on GitHub to start making your changes to the\n **main** branch (or branch off of it).\n#. Write a test which shows that the bug was fixed or that the feature\n works as expected.\n#. Send a pull request and bug the maintainer until it gets merged and\n published.\n\nRunning tests\n'''''''''''''\n\nTests can be run using [pytest](https://docs.pytest.org/en/6.2.x/).\n\n.. code-block:: bash\n\n pip install -r requirements-test.txt\n py.test\n\nRunning the test project\n''''''''''''''''''''''''\n\nThe test project can also be used as a minimal example using the following:\n\n.. code-block:: bash\n\n # Migrate the SQLite database first.\n DJANGO_SETTINGS_MODULE=tests.settings python manage.py migrate\n # Run the server with debug.\n DJANGO_SETTINGS_MODULE=tests.settings python manage.py runserver_plus\n # Run the shell.\n DJANGO_SETTINGS_MODULE=tests.settings python manage.py shell_plus\n\n.. _V\u00ed\u00f0ir Valberg Gu\u00f0mundsson (@valberg): https://github.com/valberg\n.. _Percipient Networks: https://www.strongarm.io\n.. _Valohai: https://valohai.com/\n.. _the repository: http://github.com/valohai/django-allauth-2fa\n",
"bugtrack_url": null,
"license": "",
"summary": "Adds two factor authentication to django-allauth",
"version": "0.11.1",
"project_urls": {
"Homepage": "https://github.com/valohai/django-allauth-2fa"
},
"split_keywords": [
"2fa",
"allauth",
"auth",
"authentication",
"django",
"factor",
"otp",
"two"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d3f7befd3d8fe169971cddb79eaf74e4bc6215cfef152bc772418d1cd800f6e",
"md5": "2342e4e042256a10fd3384613fd21dc2",
"sha256": "2f2d61dd488f66ad45e59780b061f5abe96caea9c3466e3ee4ea50ea1faebef6"
},
"downloads": -1,
"filename": "django_allauth_2fa-0.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2342e4e042256a10fd3384613fd21dc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14256,
"upload_time": "2023-07-13T11:09:28",
"upload_time_iso_8601": "2023-07-13T11:09:28.873262Z",
"url": "https://files.pythonhosted.org/packages/9d/3f/7befd3d8fe169971cddb79eaf74e4bc6215cfef152bc772418d1cd800f6e/django_allauth_2fa-0.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "136551b823ba7e844ceef7ac9f82e6130418fa0e616c38fe8041c012881139a4",
"md5": "bdaee1431bad7b51271add7c73436a7a",
"sha256": "02ffdf1025836f072c2f6ec0964494589cf1d52362f663f9ff6d9ca61a7b6962"
},
"downloads": -1,
"filename": "django_allauth_2fa-0.11.1.tar.gz",
"has_sig": false,
"md5_digest": "bdaee1431bad7b51271add7c73436a7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9680,
"upload_time": "2023-07-13T11:09:30",
"upload_time_iso_8601": "2023-07-13T11:09:30.523611Z",
"url": "https://files.pythonhosted.org/packages/13/65/51b823ba7e844ceef7ac9f82e6130418fa0e616c38fe8041c012881139a4/django_allauth_2fa-0.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-13 11:09:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "valohai",
"github_project": "django-allauth-2fa",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-allauth-2fa"
}
JSON
