Skip to content

Commit

Permalink
⚡📚 docs(reqirement): Update project detail and reqired python version
Browse files Browse the repository at this point in the history
  • Loading branch information
MEHRSHAD-MIRSHEKARY committed Oct 9, 2024
1 parent 1516559 commit 6904a08
Show file tree
Hide file tree
Showing 5 changed files with 483 additions and 520 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ It also provides an intuitive and powerful admin interface, allowing you to mana

## Project Detail

- Language: Python > 3.9
- Framework: Django > 4.2
- Language: Python >= 3.9
- Framework: Django >= 4.2
- Django REST Framework >= 3.14

## Documentation Overview

Expand Down
18 changes: 9 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ It also provides an intuitive and powerful admin interface, allowing you to mana
Supported Versions
------------------

`dj-notification-api` supports the following combinations of Django and Python versions:

========== =======================
Django Python
========== =======================
4.2 3.9, 3.10, 3.11, 3.12
5.0 3.10, 3.11, 3.12
5.1 3.10, 3.11, 3.12
========== =======================
`dj-notification-api` supports the following combinations of Django, REST Framework and Python versions:

========== ============== ===========================
Django REST Framework Python
========== ============== ===========================
4.2 3.14, 3.15 3.9, 3.10, 3.11, 3.12, 3.13
5.0 3.14, 3.15 3.10, 3.11, 3.12, 3.13
5.1 3.14, 3.15 3.10, 3.11, 3.12, 3.13
========== ============== ===========================

Documentation
-------------
Expand Down
210 changes: 104 additions & 106 deletions packages/requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,106 +1,104 @@
alabaster==0.7.13 ; python_version >= "3.8" and python_version < "4.0"
annotated-types==0.7.0 ; python_version >= "3.8" and python_version < "4.0"
appdirs==1.4.4 ; python_version >= "3.8" and python_version < "4.0"
argcomplete==3.5.0 ; python_version >= "3.8" and python_version < "4.0"
asgiref==3.8.1 ; python_version >= "3.8" and python_version < "4.0"
astroid==3.2.4 ; python_version >= "3.8" and python_version < "4.0"
babel==2.16.0 ; python_version >= "3.8" and python_version < "4.0"
backports-zoneinfo==0.2.1 ; python_version >= "3.8" and python_version < "3.9"
bandit[toml]==1.7.10 ; python_version >= "3.8" and python_version < "4.0"
black==24.8.0 ; python_version >= "3.8" and python_version < "4.0"
cachetools==5.5.0 ; python_version >= "3.8" and python_version < "4.0"
certifi==2024.8.30 ; python_version >= "3.8" and python_version < "4.0"
cfgv==3.4.0 ; python_version >= "3.8" and python_version < "4.0"
chardet==5.2.0 ; python_version >= "3.8" and python_version < "4.0"
charset-normalizer==3.3.2 ; python_version >= "3.8" and python_version < "4.0"
click-option-group==0.5.6 ; python_version >= "3.8" and python_version < "4"
click==8.1.7 ; python_version >= "3.8" and python_version < "4.0"
codecov==2.1.13 ; python_version >= "3.8" and python_version < "4.0"
colorama==0.4.6 ; python_version >= "3.8" and python_version < "4.0"
commitizen==3.29.1 ; python_version >= "3.8" and python_version < "4.0"
coverage==7.6.1 ; python_version >= "3.8" and python_version < "4.0"
coverage[toml]==7.6.1 ; python_version >= "3.8" and python_version < "4.0"
decli==0.6.2 ; python_version >= "3.8" and python_version < "4.0"
dill==0.3.8 ; python_version >= "3.8" and python_version < "4.0"
distlib==0.3.8 ; python_version >= "3.8" and python_version < "4.0"
django-filter==24.3 ; python_version >= "3.8" and python_version < "4.0"
django-migration-linter==5.1.0 ; python_version >= "3.8" and python_version < "4.0"
django-stubs-ext==5.1.0 ; python_version >= "3.8" and python_version < "4.0"
django-stubs==5.1.0 ; python_version >= "3.8" and python_version < "4.0"
django==4.2.16 ; python_version >= "3.8" and python_version < "3.10"
django==5.1.1 ; python_version >= "3.10" and python_version < "4.0"
djangorestframework==3.15.2 ; python_version >= "3.8" and python_version < "4.0"
docformatter==1.7.5 ; python_version >= "3.8" and python_version < "4.0"
docutils==0.19 ; python_version >= "3.8" and python_version < "4.0"
dotty-dict==1.3.1 ; python_version >= "3.8" and python_version < "4.0"
exceptiongroup==1.2.2 ; python_version >= "3.8" and python_version < "3.11"
filelock==3.16.1 ; python_version >= "3.8" and python_version < "4.0"
gitdb==4.0.11 ; python_version >= "3.8" and python_version < "4.0"
gitpython==3.1.43 ; python_version >= "3.8" and python_version < "4.0"
identify==2.6.1 ; python_version >= "3.8" and python_version < "4.0"
idna==3.10 ; python_version >= "3.8" and python_version < "4.0"
imagesize==1.4.1 ; python_version >= "3.8" and python_version < "4.0"
importlib-metadata==8.5.0 ; python_version >= "3.8" and python_version < "3.10"
importlib-resources==6.4.5 ; python_version >= "3.8" and python_version < "4.0"
iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "4.0"
isort==5.13.2 ; python_version >= "3.8" and python_version < "4.0"
jinja2==3.1.4 ; python_version >= "3.8" and python_version < "4.0"
markdown-it-py==3.0.0 ; python_version >= "3.8" and python_version < "4.0"
markupsafe==2.1.5 ; python_version >= "3.8" and python_version < "4.0"
mccabe==0.7.0 ; python_version >= "3.8" and python_version < "4.0"
mdurl==0.1.2 ; python_version >= "3.8" and python_version < "4.0"
mypy-extensions==1.0.0 ; python_version >= "3.8" and python_version < "4.0"
mypy==1.11.2 ; python_version >= "3.8" and python_version < "4.0"
nodeenv==1.9.1 ; python_version >= "3.8" and python_version < "4.0"
packaging==24.1 ; python_version >= "3.8" and python_version < "4.0"
pathspec==0.12.1 ; python_version >= "3.8" and python_version < "4.0"
pbr==6.1.0 ; python_version >= "3.8" and python_version < "4.0"
platformdirs==4.3.6 ; python_version >= "3.8" and python_version < "4.0"
pluggy==1.5.0 ; python_version >= "3.8" and python_version < "4.0"
pre-commit==3.5.0 ; python_version >= "3.8" and python_version < "4.0"
prompt-toolkit==3.0.36 ; python_version >= "3.8" and python_version < "4.0"
pydantic-core==2.23.4 ; python_version >= "3.8" and python_version < "4.0"
pydantic==2.9.2 ; python_version >= "3.8" and python_version < "4.0"
pygments==2.18.0 ; python_version >= "3.8" and python_version < "4.0"
pylint-django==2.5.5 ; python_version >= "3.8" and python_version < "4.0"
pylint-plugin-utils==0.8.2 ; python_version >= "3.8" and python_version < "4.0"
pylint==3.2.7 ; python_version >= "3.8" and python_version < "4.0"
pyproject-api==1.8.0 ; python_version >= "3.8" and python_version < "4.0"
pytest-cov==5.0.0 ; python_version >= "3.8" and python_version < "4.0"
pytest-django==4.9.0 ; python_version >= "3.8" and python_version < "4.0"
pytest==8.3.3 ; python_version >= "3.8" and python_version < "4.0"
python-gitlab==4.11.1 ; python_version >= "3.8" and python_version < "4.0"
python-semantic-release==9.8.8 ; python_version >= "3.8" and python_version < "4.0"
pytz==2024.2 ; python_version >= "3.8" and python_version < "3.9"
pyyaml==6.0.2 ; python_version >= "3.8" and python_version < "4.0"
questionary==2.0.1 ; python_version >= "3.8" and python_version < "4.0"
requests-toolbelt==1.0.0 ; python_version >= "3.8" and python_version < "4.0"
requests==2.32.3 ; python_version >= "3.8" and python_version < "4.0"
rich==13.8.1 ; python_version >= "3.8" and python_version < "4.0"
shellingham==1.5.4 ; python_version >= "3.8" and python_version < "4.0"
smmap==5.0.1 ; python_version >= "3.8" and python_version < "4.0"
snowballstemmer==2.2.0 ; python_version >= "3.8" and python_version < "4.0"
sphinx-rtd-theme==2.0.0 ; python_version >= "3.8" and python_version < "4.0"
sphinx==6.2.1 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-applehelp==1.0.4 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-devhelp==1.0.2 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-htmlhelp==2.0.1 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-jquery==4.1 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-qthelp==1.0.3 ; python_version >= "3.8" and python_version < "4.0"
sphinxcontrib-serializinghtml==1.1.5 ; python_version >= "3.8" and python_version < "4.0"
sqlparse==0.5.1 ; python_version >= "3.8" and python_version < "4.0"
stevedore==5.3.0 ; python_version >= "3.8" and python_version < "4.0"
termcolor==2.4.0 ; python_version >= "3.8" and python_version < "4.0"
toml==0.10.2 ; python_version >= "3.8" and python_version < "4.0"
tomli==2.0.1 ; python_version >= "3.8" and python_full_version <= "3.11.0a6"
tomlkit==0.13.2 ; python_version >= "3.8" and python_version < "4.0"
tox==4.20.0 ; python_version >= "3.8" and python_version < "4.0"
types-pyyaml==6.0.12.20240917 ; python_version >= "3.8" and python_version < "4.0"
typing-extensions==4.12.2 ; python_version >= "3.8" and python_version < "4.0"
tzdata==2024.2 ; python_version >= "3.8" and python_version < "4.0" and sys_platform == "win32"
untokenize==0.1.1 ; python_version >= "3.8" and python_version < "4.0"
urllib3==2.2.3 ; python_version >= "3.8" and python_version < "4.0"
virtualenv==20.26.5 ; python_version >= "3.8" and python_version < "4.0"
wcwidth==0.2.13 ; python_version >= "3.8" and python_version < "4.0"
zipp==3.20.2 ; python_version >= "3.8" and python_version < "3.10"
alabaster==0.7.16 ; python_version >= "3.9" and python_version < "4.0"
annotated-types==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
appdirs==1.4.4 ; python_version >= "3.9" and python_version < "4.0"
argcomplete==3.5.1 ; python_version >= "3.9" and python_version < "4.0"
asgiref==3.8.1 ; python_version >= "3.9" and python_version < "4.0"
astroid==3.3.5 ; python_version >= "3.9" and python_version < "4.0"
babel==2.16.0 ; python_version >= "3.9" and python_version < "4.0"
bandit[toml]==1.7.10 ; python_version >= "3.9" and python_version < "4.0"
black==24.10.0 ; python_version >= "3.9" and python_version < "4.0"
cachetools==5.5.0 ; python_version >= "3.9" and python_version < "4.0"
certifi==2024.8.30 ; python_version >= "3.9" and python_version < "4.0"
cfgv==3.4.0 ; python_version >= "3.9" and python_version < "4.0"
chardet==5.2.0 ; python_version >= "3.9" and python_version < "4.0"
charset-normalizer==3.4.0 ; python_version >= "3.9" and python_version < "4.0"
click-option-group==0.5.6 ; python_version >= "3.9" and python_version < "4"
click==8.1.7 ; python_version >= "3.9" and python_version < "4.0"
codecov==2.1.13 ; python_version >= "3.9" and python_version < "4.0"
colorama==0.4.6 ; python_version >= "3.9" and python_version < "4.0"
commitizen==3.29.1 ; python_version >= "3.9" and python_version < "4.0"
coverage==7.6.2 ; python_version >= "3.9" and python_version < "4.0"
coverage[toml]==7.6.2 ; python_version >= "3.9" and python_version < "4.0"
decli==0.6.2 ; python_version >= "3.9" and python_version < "4.0"
dill==0.3.9 ; python_version >= "3.9" and python_version < "4.0"
distlib==0.3.8 ; python_version >= "3.9" and python_version < "4.0"
django-filter==24.3 ; python_version >= "3.9" and python_version < "4.0"
django-migration-linter==5.1.0 ; python_version >= "3.9" and python_version < "4.0"
django-stubs-ext==5.1.0 ; python_version >= "3.9" and python_version < "4.0"
django-stubs==5.1.0 ; python_version >= "3.9" and python_version < "4.0"
django==4.2.16 ; python_version >= "3.9" and python_version < "3.10"
django==5.1.2 ; python_version >= "3.10" and python_version < "4.0"
djangorestframework==3.15.2 ; python_version >= "3.9" and python_version < "4.0"
docformatter==1.7.5 ; python_version >= "3.9" and python_version < "4.0"
docutils==0.19 ; python_version >= "3.9" and python_version < "4.0"
dotty-dict==1.3.1 ; python_version >= "3.9" and python_version < "4.0"
exceptiongroup==1.2.2 ; python_version >= "3.9" and python_version < "3.11"
filelock==3.16.1 ; python_version >= "3.9" and python_version < "4.0"
gitdb==4.0.11 ; python_version >= "3.9" and python_version < "4.0"
gitpython==3.1.43 ; python_version >= "3.9" and python_version < "4.0"
identify==2.6.1 ; python_version >= "3.9" and python_version < "4.0"
idna==3.10 ; python_version >= "3.9" and python_version < "4.0"
imagesize==1.4.1 ; python_version >= "3.9" and python_version < "4.0"
importlib-metadata==8.5.0 ; python_version >= "3.9" and python_version < "3.10"
importlib-resources==6.4.5 ; python_version >= "3.9" and python_version < "4.0"
iniconfig==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
isort==5.13.2 ; python_version >= "3.9" and python_version < "4.0"
jinja2==3.1.4 ; python_version >= "3.9" and python_version < "4.0"
markdown-it-py==3.0.0 ; python_version >= "3.9" and python_version < "4.0"
markupsafe==3.0.1 ; python_version >= "3.9" and python_version < "4.0"
mccabe==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
mdurl==0.1.2 ; python_version >= "3.9" and python_version < "4.0"
mypy-extensions==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
mypy==1.11.2 ; python_version >= "3.9" and python_version < "4.0"
nodeenv==1.9.1 ; python_version >= "3.9" and python_version < "4.0"
packaging==24.1 ; python_version >= "3.9" and python_version < "4.0"
pathspec==0.12.1 ; python_version >= "3.9" and python_version < "4.0"
pbr==6.1.0 ; python_version >= "3.9" and python_version < "4.0"
platformdirs==4.3.6 ; python_version >= "3.9" and python_version < "4.0"
pluggy==1.5.0 ; python_version >= "3.9" and python_version < "4.0"
pre-commit==3.8.0 ; python_version >= "3.9" and python_version < "4.0"
prompt-toolkit==3.0.36 ; python_version >= "3.9" and python_version < "4.0"
pydantic-core==2.23.4 ; python_version >= "3.9" and python_version < "4.0"
pydantic==2.9.2 ; python_version >= "3.9" and python_version < "4.0"
pygments==2.18.0 ; python_version >= "3.9" and python_version < "4.0"
pylint-django==2.5.5 ; python_version >= "3.9" and python_version < "4.0"
pylint-plugin-utils==0.8.2 ; python_version >= "3.9" and python_version < "4.0"
pylint==3.3.1 ; python_version >= "3.9" and python_version < "4.0"
pyproject-api==1.8.0 ; python_version >= "3.9" and python_version < "4.0"
pytest-cov==5.0.0 ; python_version >= "3.9" and python_version < "4.0"
pytest-django==4.9.0 ; python_version >= "3.9" and python_version < "4.0"
pytest==8.3.3 ; python_version >= "3.9" and python_version < "4.0"
python-gitlab==4.13.0 ; python_version >= "3.9" and python_version < "4.0"
python-semantic-release==9.10.0 ; python_version >= "3.9" and python_version < "4.0"
pyyaml==6.0.2 ; python_version >= "3.9" and python_version < "4.0"
questionary==2.0.1 ; python_version >= "3.9" and python_version < "4.0"
requests-toolbelt==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
requests==2.32.3 ; python_version >= "3.9" and python_version < "4.0"
rich==13.9.2 ; python_version >= "3.9" and python_version < "4.0"
shellingham==1.5.4 ; python_version >= "3.9" and python_version < "4.0"
smmap==5.0.1 ; python_version >= "3.9" and python_version < "4.0"
snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
sphinx-rtd-theme==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
sphinx==6.2.1 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-applehelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-devhelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-htmlhelp==2.1.0 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-jquery==4.1 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-qthelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
sphinxcontrib-serializinghtml==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
sqlparse==0.5.1 ; python_version >= "3.9" and python_version < "4.0"
stevedore==5.3.0 ; python_version >= "3.9" and python_version < "4.0"
termcolor==2.5.0 ; python_version >= "3.9" and python_version < "4.0"
toml==0.10.2 ; python_version >= "3.9" and python_version < "4.0"
tomli==2.0.2 ; python_version >= "3.9" and python_full_version <= "3.11.0a6"
tomlkit==0.13.2 ; python_version >= "3.9" and python_version < "4.0"
tox==4.21.2 ; python_version >= "3.9" and python_version < "4.0"
types-pyyaml==6.0.12.20240917 ; python_version >= "3.9" and python_version < "4.0"
typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "4.0"
tzdata==2024.2 ; python_version >= "3.9" and python_version < "4.0" and sys_platform == "win32"
untokenize==0.1.1 ; python_version >= "3.9" and python_version < "4.0"
urllib3==2.2.3 ; python_version >= "3.9" and python_version < "4.0"
virtualenv==20.26.6 ; python_version >= "3.9" and python_version < "4.0"
wcwidth==0.2.13 ; python_version >= "3.9" and python_version < "4.0"
zipp==3.20.2 ; python_version >= "3.9" and python_version < "3.10"
17 changes: 8 additions & 9 deletions packages/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
asgiref==3.8.1 ; python_version >= "3.8" and python_version < "4.0"
backports-zoneinfo==0.2.1 ; python_version >= "3.8" and python_version < "3.9"
django-filter==24.3 ; python_version >= "3.8" and python_version < "4.0"
django==4.2.16 ; python_version >= "3.8" and python_version < "3.10"
django==5.1.1 ; python_version >= "3.10" and python_version < "4.0"
djangorestframework==3.15.2 ; python_version >= "3.8" and python_version < "4.0"
sqlparse==0.5.1 ; python_version >= "3.8" and python_version < "4.0"
typing-extensions==4.12.2 ; python_version >= "3.8" and python_version < "3.11"
tzdata==2024.2 ; python_version >= "3.8" and python_version < "4.0" and sys_platform == "win32"
asgiref==3.8.1 ; python_version >= "3.9" and python_version < "4.0"
django-filter==24.3 ; python_version >= "3.9" and python_version < "4.0"
django==4.2.16 ; python_version >= "3.9" and python_version < "3.10"
django==5.1.2 ; python_version >= "3.10" and python_version < "4.0"
djangorestframework==3.15.2 ; python_version >= "3.9" and python_version < "4.0"
sqlparse==0.5.1 ; python_version >= "3.9" and python_version < "4.0"
typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "3.11"
tzdata==2024.2 ; python_version >= "3.9" and python_version < "4.0" and sys_platform == "win32"
Loading

0 comments on commit 6904a08

Please sign in to comment.