pyproject.toml

[build-system]
requires = ["setuptools", "wheel"]

[project]
name = "nitrate-tcms"
description = "A full-featured Test Case Management System"
readme = "README.rst"
authors = [
    {name = "Nitrate Team"}
]
maintainers = [
    {name = "Chenxiong Qi", email = "qcxhome@gmail.com"}
]
license = {text = "GPLv2+"}
keywords = ["test", "case", "plan", "run"]
requires-python = ">=3.10"
classifiers = [
    "Framework :: Django",
    "Framework :: Django :: 4.2",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3 :: Only",
    "Topic :: Software Development :: Quality Assurance",
    "Topic :: Software Development :: Testing"
]
dependencies = [
    "beautifulsoup4==4.14.3",
    "Django==4.2.30",
    "django-contrib-comments==2.2.0",
    "django-tinymce==3.5.0",
    "django-uuslug==2.0.0",
    "html2text==2025.4.15",
    "odfpy==1.4.1",
    "xmltodict==1.0.4",
    "kobo==0.41.0",
]
dynamic = ["version"]

[project.optional-dependencies]
mysql = ["mysqlclient==2.2.8"]
pgsql = ["psycopg2==2.9.11"]
krbauth = ["kerberos==1.3.1"]
bugzilla = ["python-bugzilla==3.3.0"]
socialauth = ["social-auth-app-django==5.4.3"]
async = ["celery==5.6.3"]
docs = ["Sphinx >= 1.1.2", "sphinx_rtd_theme"]
mypy-check = [
    # mypy check. Versions of these two packages have to be adjusted according
    # to the version of Django in order to work together well.
    "django-stubs==4.2.7",
    "mypy>=1.7,<1.8",
]
devtools = [
    "django-debug-toolbar",
    "tox==4.52.1",
    "tox-uv==1.35.2",
    # Build tool to build sdist: python3 -m build
    "build",
]
tests = [
    "coverage[toml]==7.13.5",
    "factory_boy==3.3.3",
    "pytest==9.0.3",
    "pytest-cov==7.1.0",
    "pytest-django==4.12.0",
    "sqlparse==0.5.5",
]

[project.urls]
Repository = "https://github.com/Nitrate/Nitrate"
Documentation = "https://nitrate.readthedocs.io/"
"Issue Tracker" = "https://github.com/Nitrate/Nitrate/issues"
"Source Code" = "https://github.com/Nitrate/Nitrate"
"Release Notes" = "https://nitrate.readthedocs.io/en/latest/releases/"
"Container Images" = "https://quay.io/organization/nitrate"

[tool.setuptools]
platforms = ["any"]
zip-safe = false
include-package-data = true

[tool.setuptools.dynamic]
version = {file = "VERSION.txt"}

[tool.setuptools.packages.find]
where = ["src"]
exclude = ["tests*"]
namespaces = false

[tool.black]
line-length = 100
target-version = ['py310']
check = 1
diff = 1

[tool.isort]
line_length = 100
extend_skip = ["migrations"]
profile = "black"

[tool.mypy]
plugins = ["mypy_django_plugin.main"]
ignore_missing_imports = 1
exclude = ["settings", "migrations"]

[tool.django-stubs]
django_settings_module = "tcms.settings.test"

[tool.pytest.ini_options]
DJANGO_SETTINGS_MODULE = "tcms.settings.test"
python_files = "test_*.py"
addopts = "--cov=src/tcms/ --cov-report=term --cov-report=html --cov-report=xml"
# This magic value causes py.test does not collect arbitrary classes, like
# Nitrate's TestCase, TestPlan, and TestRun, that are wrongly treated as tests.
# This value lets py.test only collect classes that is derived from either
# django.test.TestCase or unittest.TestCase
# So, if anyone writes a test class with a name including this string, it is
# incorrect.
# Refer to http://doc.pytest.org/en/latest/customize.html#confval-python_classes
python_classes = "*xxxxxxxxx*"

# Reference: pytest-django document: managing_python_path.html#automatic-looking-for-django-projects
# Installation is skipped in tox testenv. pytest-django has to be able to discover the settings module.
# By following the document mentioned above, disable automatic discovery and set Python path explicitly.
# Note that src-layout is used and manage.py locates under src/ directory.
django_find_project = false
pythonpath = ". src"

[tool.coverage.run]
branch = true

[tool.coverage.report]
skip_covered = true
omit = [
    "*/migrations/*.py",
    "src/tcms/celery.py",
    "src/tcms/__init__.py",
    "src/tcms/settings/*.py",
    "src/tcms/wsgi.py",
    "*/urls.py",
    "*/urls/*.py"
]

[tool.bandit]
exclude_dirs = ["/tests/"]
skips = ["B105", "B411"]
# B105: hardcoded_password_string - Empty strings in default Django settings
# B411: import_xmlrpclib - Using Fault for exceptions, not parsing untrusted XML