tox.ini

[tox]
envlist = py{311,312}-django{42}, quality, docs, pii_check, lint-imports

[doc8]
; D001 = Line too long
ignore=D001

[pycodestyle]
exclude = .git,.tox,migrations
max-line-length = 120

[pydocstyle]
; D101 = Missing docstring in public class
; D200 = One-line docstring should fit on one line with quotes
; D203 = 1 blank line required before class docstring
; D212 = Multi-line docstring summary should start at the first line
; D215 = Section underline is over-indented (numpy style)
; D404 = First word of the docstring should not be This (numpy style)
; D405 = Section name should be properly capitalized (numpy style)
; D406 = Section name should end with a newline (numpy style)
; D407 = Missing dashed underline after section (numpy style)
; D408 = Section underline should be in the line following the section’s name (numpy style)
; D409 = Section underline should match the length of its name (numpy style)
; D410 = Missing blank line after section (numpy style)
; D411 = Missing blank line before section (numpy style)
; D412 = No blank lines allowed between a section header and its content (numpy style)
; D413 = Missing blank line after last section (numpy style)
; D414 = Section has no content (numpy style)
ignore = D101,D200,D203,D212,D215,D404,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414
match-dir = (?!migrations)

[pytest]
DJANGO_SETTINGS_MODULE = test_settings
addopts = --cov openedx_learning --cov openedx_tagging --cov tests --cov-report term-missing --cov-report xml
norecursedirs = .* docs requirements site-packages

[testenv]
deps =
    setuptools
    django42: Django>=4.2,<5.0
    -r{toxinidir}/requirements/test.txt
setenv =
    # Note that the django32/django42 targets use MySQL, but running pytest by
    # itself (without tox) will run tests in SQLite for developer convenience.
    DJANGO_SETTINGS_MODULE = mysql_test_settings
commands =
    pytest {posargs}

[testenv:docs]
setenv =
    DJANGO_SETTINGS_MODULE = test_settings
    PYTHONPATH = {toxinidir}
    # Adding the option here instead of as a default in the docs Makefile because that Makefile is generated by sphinx.
    # SPHINXOPTS = -W
allowlist_externals =
    make
    rm
deps =
    -r{toxinidir}/requirements/doc.txt
commands =
    doc8 --ignore-path docs/_build README.rst docs
    rm -f docs/openedx_learning.rst
    rm -f docs/modules.rst
    make -e -C docs clean
    make -e -C docs html
    python setup.py check --restructuredtext --strict

[testenv:quality]
allowlist_externals =
    make
    rm
    touch
deps =
    setuptools
    -r{toxinidir}/requirements/quality.txt
commands =
    pylint openedx_learning openedx_tagging tests test_utils manage.py setup.py
    mypy
    pycodestyle openedx_learning openedx_tagging tests manage.py setup.py
    pydocstyle openedx_learning openedx_tagging tests manage.py setup.py
    isort --check-only --diff tests test_utils openedx_learning openedx_tagging manage.py setup.py test_settings.py
    make selfcheck

[testenv:pii_check]
setenv =
    DJANGO_SETTINGS_MODULE = test_settings
deps =
    -r{toxinidir}/requirements/test.txt
commands =
    code_annotations django_find_annotations --config_file .pii_annotations.yml --lint --report --coverage

[testenv:package]
deps =
    build
    twine
commands =
    python -m build
    twine check dist/*