Merge branch 'master' into segregate-dependencies-with-optional-extra-require

* master:
  docs: Move CHANGELOG out of README
  chore: Add Py3.12, Py3.13 in Github Actions
  chore: Upgrade ruff tooling
  chore: Upgrade requirements + support Django5

Author: CuriousLearner

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
     timeout-minutes: 9
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v3
@@ -32,6 +32,6 @@ jobs:
           python -m pip install tox tox-gh-actions
           python -m pip install -r requirements/testing.txt
       - name: Run ruff
-        run: ruff .
+        run: ruff check .
       - name: Test with tox
         run: tox

CHANGELOG.rst

@@ -0,0 +1,122 @@
+Release Notes
+-------------
+
+[Dev]
+^^^^^
+
+Added
+"""""
+- Support for Python 3.11, 3.12, 3.13
+- CI tests for Py{311,312,313}-Django{2x,3x,4x,5x}.
+
+[3.0.0]
+^^^^^^^
+
+Added
+"""""
+- Support for Django 4.x.
+- Support for Django 3.2.
+
+Changed
+"""""""
+- Method ``phone_verify.backends.nexmo.NexmoBackend.send_sms`` changes parameter name from ``numbers`` to ``number`` to be consistent with rest of the inherited classes.
+
+[2.0.1]
+^^^^^^^
+
+Added
+"""""
+- Support for Python 3.8 & Python 3.9.
+- CI tests for Py{36,37,38,39}-Django{20,21,22,30,31}.
+
+Changed
+"""""""
+- Fixed issue ``generate_session_token`` to handle cases in Py38, Py39 when the ``session_token`` is already ``string`` instead of ``bytes``.
+
+[2.0.0]
+^^^^^^^
+
+**NOTE**: The previous version of this library provided the ``security_code`` in the JWT ``session_token``. You would have to re-verify ``phone_numbers`` in *this* version to ensure they are authentically verified.
+
+Added
+"""""
+
+- Tests added to provide 100% coverage on the package.
+- Add ``nexmo.errors.ClientError`` as exception class in ``phone_verify.backends.nexmo.NexmoBackend`` & ``phone_verify.backends.nexmo.NexmoSandboxBackend``.
+
+Changed
+"""""""
+
+- Method signature changed for ``phone_verify.backends.BaseBackend.generate_session_token``. It now accepts only ``phone_number`` instead of combination of ``phone_number`` and ``security_code``.
+- Remove the ``security_code`` from JWT ``session_token`` to avoid leaking information.
+- Add nonce in ``session_token`` to generate unique tokens for each ``phone_number``.
+- Fixes call to ``phone_verify.backends.nexmo.NexmoBackend.send_sms`` method.
+
+[1.1.0]
+^^^^^^^
+
+Added
+"""""
+
+- Support ``Nexmo`` as a backend service along with ``Twilio``.
+- Add docs for writing a custom backend.
+
+Changed
+"""""""
+
+- Update ``backends.base.BaseBackend.validate_security_code`` to use ``save()`` instead of ``update()`` to allow Django to emit its ``post_save()`` signal.
+
+[1.0.0]
+^^^^^^^
+
+Added
+"""""
+
+- Add coverage report through ``coveralls``.
+- Support for One-Time Passwords (OTP) using ``VERIFY_SECURITY_CODE_ONLY_ONCE`` as ``True`` in the settings.
+- Script to support makemigrations for development.
+- ``BaseBackend`` status now have ``SECURITY_CODE_VERIFIED`` and ``SESSION_TOKEN_INVALID`` status to support new states.
+
+Changed
+"""""""
+
+- Rename ``TWILIO_SANDBOX_TOKEN`` to ``SANDBOX_TOKEN``.
+- Fix signature for ``send_bulk_sms`` method in ``TwilioBackend`` and ``TwilioSandboxBackend``.
+- Response for ``/api/phone/register`` contains key ``session_token`` instead of ``session_code``.
+- Request payload for ``/api/phone/verify`` now expects ``session_token`` key instead of ``session_code``.
+- Response for ``/api/phone/verify`` now sends additional response of ``Security code is already verified`` in case ``VERIFY_SECURITY_CODE_ONLY_ONCE`` is set to ``True``.
+- Rename ``otp`` to ``security_code`` in code and docs to be more consistent.
+- Rename ``BaseBackend`` status from ``VALID``, ``INVALID``, ``EXPIRED`` to ``SECURITY_CODE_VALID``, ``SECURITY_CODE_INVALID``, and ``SECURITY_CODE_EXPIRED`` respectively.
+- Rename ``session_code`` to ``session_token`` to be consistent in code and naming across the app.
+- Rename service ``send_otp_and_generate_session_code`` to ``send_security_code_and_generate_session_token``.
+- Rename method ``BaseBackend.generate_token`` to ``BaseBackend.generate_security_code``.
+- Rename method ``create_otp_and_session_token`` to ``create_security_code_and_session_token``.
+- Rename method ``BaseBackend.validate_token`` to ``BaseBackend.validate_security_code`` with an additional parameter of ``session_token``.
+
+[0.2.0]
+^^^^^^^
+
+Added
+"""""
+
+- ``pre-commit-config`` to maintain code quality using black and other useful tools.
+- Docs for integration and usage in `getting_started.rst`_.
+- Tox for testing on `py{37}-django{20,21,22}`.
+- Travis CI for testing builds.
+
+Changed
+"""""""
+
+- Convert ``*.md`` docs to reST Markup.
+- Fix issue with installing required package dependencies via ``install_requires``.
+
+[0.1.1]
+^^^^^^^
+
+Added
+"""""
+
+- README and documentation of API endpoints.
+- ``setup.cfg`` to manage coverage.
+- ``phone_verify`` app including backends, requirements, tests.
+- Initial app setup.

README.rst

@@ -112,125 +112,9 @@ Licence
 
 GPLv3
 
-Release Notes
--------------
-
-[Dev]
-^^^^^
-
-Added
-"""""
-- Support for Python 3.11.
-- CI tests for Py{311}-Django{2x,3x,4x}.
-
-[3.0.0]
-^^^^^^^
-
-Added
-"""""
-- Support for Django 4.x.
-- Support for Django 3.2.
-
-Changed
-"""""""
-- Method ``phone_verify.backends.nexmo.NexmoBackend.send_sms`` changes parameter name from ``numbers`` to ``number`` to be consistent with rest of the inherited classes.
-
-[2.0.1]
-^^^^^^^
-
-Added
-"""""
-- Support for Python 3.8 & Python 3.9.
-- CI tests for Py{36,37,38,39}-Django{20,21,22,30,31}.
-
-Changed
-"""""""
-- Fixed issue ``generate_session_token`` to handle cases in Py38, Py39 when the ``session_token`` is already ``string`` instead of ``bytes``.
-
-[2.0.0]
-^^^^^^^
-
-**NOTE**: The previous version of this library provided the ``security_code`` in the JWT ``session_token``. You would have to re-verify ``phone_numbers`` in *this* version to ensure they are authentically verified.
-
-Added
-"""""
-
-- Tests added to provide 100% coverage on the package.
-- Add ``nexmo.errors.ClientError`` as exception class in ``phone_verify.backends.nexmo.NexmoBackend`` & ``phone_verify.backends.nexmo.NexmoSandboxBackend``.
-
-Changed
-"""""""
-
-- Method signature changed for ``phone_verify.backends.BaseBackend.generate_session_token``. It now accepts only ``phone_number`` instead of combination of ``phone_number`` and ``security_code``.
-- Remove the ``security_code`` from JWT ``session_token`` to avoid leaking information.
-- Add nonce in ``session_token`` to generate unique tokens for each ``phone_number``.
-- Fixes call to ``phone_verify.backends.nexmo.NexmoBackend.send_sms`` method.
-
-[1.1.0]
-^^^^^^^
-
-Added
-"""""
-
-- Support ``Nexmo`` as a backend service along with ``Twilio``.
-- Add docs for writing a custom backend.
-
-Changed
-"""""""
-
-- Update ``backends.base.BaseBackend.validate_security_code`` to use ``save()`` instead of ``update()`` to allow Django to emit its ``post_save()`` signal.
-
-[1.0.0]
-^^^^^^^
-
-Added
-"""""
-
-- Add coverage report through ``coveralls``.
-- Support for One-Time Passwords (OTP) using ``VERIFY_SECURITY_CODE_ONLY_ONCE`` as ``True`` in the settings.
-- Script to support makemigrations for development.
-- ``BaseBackend`` status now have ``SECURITY_CODE_VERIFIED`` and ``SESSION_TOKEN_INVALID`` status to support new states.
-
-Changed
-"""""""
-
-- Rename ``TWILIO_SANDBOX_TOKEN`` to ``SANDBOX_TOKEN``.
-- Fix signature for ``send_bulk_sms`` method in ``TwilioBackend`` and ``TwilioSandboxBackend``.
-- Response for ``/api/phone/register`` contains key ``session_token`` instead of ``session_code``.
-- Request payload for ``/api/phone/verify`` now expects ``session_token`` key instead of ``session_code``.
-- Response for ``/api/phone/verify`` now sends additional response of ``Security code is already verified`` in case ``VERIFY_SECURITY_CODE_ONLY_ONCE`` is set to ``True``.
-- Rename ``otp`` to ``security_code`` in code and docs to be more consistent.
-- Rename ``BaseBackend`` status from ``VALID``, ``INVALID``, ``EXPIRED`` to ``SECURITY_CODE_VALID``, ``SECURITY_CODE_INVALID``, and ``SECURITY_CODE_EXPIRED`` respectively.
-- Rename ``session_code`` to ``session_token`` to be consistent in code and naming across the app.
-- Rename service ``send_otp_and_generate_session_code`` to ``send_security_code_and_generate_session_token``.
-- Rename method ``BaseBackend.generate_token`` to ``BaseBackend.generate_security_code``.
-- Rename method ``create_otp_and_session_token`` to ``create_security_code_and_session_token``.
-- Rename method ``BaseBackend.validate_token`` to ``BaseBackend.validate_security_code`` with an additional parameter of ``session_token``.
-
-[0.2.0]
-^^^^^^^
-
-Added
-"""""
-
-- ``pre-commit-config`` to maintain code quality using black and other useful tools.
-- Docs for integration and usage in `getting_started.rst`_.
-- Tox for testing on `py{37}-django{20,21,22}`.
-- Travis CI for testing builds.
-
-Changed
-"""""""
-
-- Convert ``*.md`` docs to reST Markup.
-- Fix issue with installing required package dependencies via ``install_requires``.
-
-[0.1.1]
-^^^^^^^
+Changelog
+---------
 
-Added
-"""""
+See `changelog.rst`_
 
-- README and documentation of API endpoints.
-- ``setup.cfg`` to manage coverage.
-- ``phone_verify`` app including backends, requirements, tests.
-- Initial app setup.
+.. _changelog.rst: https://github.com/CuriousLearner/django-phone-verify/blob/master/CHANGELOG.rst

requirements/common.txt

@@ -1,14 +1,14 @@
 # Core Stuff
 # -------------------------------------
-PyJWT==2.8.0
+PyJWT==2.10.1
 
 # Configuration
 # -------------------------------------
-python-dotenv==1.0.0
+python-dotenv==1.0.1
 
 # Phone number related Stuff
 # -------------------------------------
-phonenumbers==8.13.25
-django-phonenumber-field==7.2.0
-twilio==8.10.2
+phonenumbers==9.0.1
+django-phonenumber-field==8.0.0
+twilio==9.5.1
 nexmo==2.5.2

requirements/development.txt

@@ -3,9 +3,9 @@
 
 # Core Stuff
 # -------------------------------------
-Django==4.2.7
-djangorestframework==3.14.0
+Django==4.2.20
+djangorestframework==3.15.2
 
 # Code quality
 #--------------------------------------
-pre-commit==3.5.0
+pre-commit==4.2.0

requirements/testing.txt

@@ -1,10 +1,10 @@
 # Testing
 # -------------------------------------
-pytest==7.4.3
-pytest-django==4.7.0
-pytest-cov==4.1.0
+pytest==8.3.5
+pytest-django==4.10.0
+pytest-cov==6.0.0
 
 django-dynamic-fixture==4.0.1
-pytest-mock==3.12.0
-tox==4.11.3
-ruff==0.1.6
+pytest-mock==3.14.0
+tox==4.24.2
+ruff==0.11.2

ruff.toml

@@ -1,4 +1,13 @@
 line-length = 120
+exclude = [
+    ".tox",
+    ".git",
+    "docs",
+    "venv",
+    ".venv",
+]
+
+[lint]
 select = [
     'B',  # flake8-bugbear
     'E',  # pycodestyle errors
@@ -7,13 +16,6 @@ select = [
     'W',  # pycodestyle warnings
     'B9',
 ]
-exclude = [
-    ".tox",
-    ".git",
-    "docs",
-    "venv",
-    ".venv",
-]
 
-[isort]
+[lint.isort]
 known-first-party = ["phone_verify"]

tox.ini

@@ -1,18 +1,21 @@
 [tox]
 distribute = False
 envlist =
-    py{39,310,311}-django{2x,3x,4x}
+    py{39,310,311,312,313}-django{2x,3x,4x,5x}
 skip_missing_interpreters = True
 
 [gh-actions]
 python =
     3.9: py39
     3.10: py310
     3.11: py311
+    3.12: py312
+    3.13: py313
 django=
     django2x: Django>=2.0,<3.0
-    django3x: Django>=3.0,<3.2.13
-    django4x: Django>=4.0
+    django3x: Django>=3.0,<4.0
+    django4x: Django>=4.0,<5.0
+    django5x: Django>=5.0,<6.0
 
 [testenv]
 usedevelop = True
@@ -24,6 +27,7 @@ deps =
     django30: Django>=3.0,<3.1
     django31: Django>=3.1,<3.1.13
     django32: Django>=3.2,<3.2.5
-    django40: Django>=4.0
+    django40: Django>=4.0,<4.3
+    django50: Django>=5.0,<6.0
 commands =
     pytest --cov -v --tb=native