Skip to content

Conversation

William-Blackie
Copy link

Hi all,

love the package. I stumbled across an issue that it's clear from looking through the issues; (#469) that the phonenumberfield/configuration is required, can we update the documentation to reflect this? This cost me a number of hours trying to dig this issue out.

Description

Simple one line change to reflect that the phonenumber package is required.

Motivation and Context

It makes it clear that even if you do not use the phone number field, it is required.

How Has This Been Tested?

N/a.

Screenshots (if appropriate):

N/a.

Types of changes

  • [ x ] Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • [ x ] My change requires a change to the documentation.
  • [ x ] I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@claudep
Copy link
Contributor

claudep commented May 29, 2025

In fact, I'd rather push for finishing the work on PR #654 to finally be able to make phonenumber packages really optional.

'otp_yubikey', # <- for yubikey capability.
'two_factor',
'two_factor.plugins.phonenumber', # <- for phone number capability.
'two_factor.plugins.phonenumber', # <- Required, even if phone is not used.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is true - I currently use two_factor without the phone number plugin listed in my INSTALLED_APPS: https://codeberg.org/Inboxen/Inboxen/src/commit/e441dd4aece7028b32307b1e7980ff5301a37814/inboxen/settings.py#L248

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do have to install the phonenumbers and django-phonenumber-field packages which is what needs to be solved to close #469 if i understand things correctly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants