weblate/pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = [
  "setuptools>=78.0.2",
  "translate-toolkit"
]

[dependency-groups]
dev = [
  {include-group = "docs"},
  {include-group = "lint"},
  {include-group = "scripts"},
  {include-group = "test"},
  {include-group = "types"}
]
docs = [
  "furo==2025.7.19",
  "jinja2==3.1.6",
  "matplotlib==3.10.6",
  "Pillow>=11.0.0,<12",
  "Pygments>=2.19.0,<3.0",
  "sphinx-copybutton==0.5.2",
  "sphinx-jsonschema==1.19.1",
  "sphinx-reredirects==1.0.0",
  "Sphinx==8.2.3",
  "sphinxcontrib-httpdomain==1.8.1",
  "sphinxext-opengraph==0.13.0"
]
lint = [
  {include-group = "pre-commit"},
  {include-group = "pylint"}
]
pre-commit = [
  "pre-commit==4.3.0"
]
pylint = [
  "pylint==3.3.8"
]
scripts = [
  "django-debug-toolbar==6.0.0",
  "PyICU==2.15.2",
  "reuse==5.1.0",
  "scour==0.38.2",
  "tinyunicodeblock==1.3"
]
test = [
  "coverage==7.10.6",
  "pytest-cov==6.2.1",
  "pytest-django==4.11.1",
  "pytest-github-actions-annotate-failures==0.3.0",
  "pytest-profiling==1.8.1",
  "pytest-xdist==3.8.0",
  "pytest==8.4.2",
  "responses==0.25.8",
  "respx==0.22.0",
  "selenium==4.35.0"
]
types = [
  "boto3-stubs==1.40.24",
  "celery-types==0.23.0",
  "django-stubs-ext==5.2.2",
  "django-stubs[compatible-mypy]==5.2.2",
  "djangorestframework-stubs==3.16.2",
  "mypy==1.17.1",
  "PyGObject-stubs==2.13.0",
  "types-dateparser==1.2.2.20250809",
  "types-docutils==0.22.0.20250822",
  "types-jsonschema==4.25.1.20250822",
  "types-lxml==2025.8.25",
  "types-openpyxl==3.1.5.20250822",
  "types-Pillow==10.2.0.20240822",
  "types-python-dateutil==2.9.0.20250822",
  "types-regex==2025.9.1.20250903",
  "types-requests==2.32.4.20250809",
  "types-setuptools==80.9.0.20250822"
]

[project]
authors = [
  {email = "michal@weblate.org", name = "Michal Čihař"}
]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Web Environment",
  "Framework :: Django",
  "Intended Audience :: Developers",
  "Intended Audience :: System Administrators",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python",
  "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
  "Topic :: Internet :: WWW/HTTP",
  "Topic :: Software Development :: Internationalization",
  "Topic :: Software Development :: Localization"
]
dependencies = [
  "aeidon>=1.15,<1.16",
  "ahocorasick-rs>=0.22.0,<0.23.0",
  "altcha>=0.2.0,<0.3",
  "borgbackup>=1.4.0,<1.5",
  "celery[redis]>=5.5.3,<5.6",
  "certifi>=2025.6.15",
  "charset-normalizer>=3.4.0,<4.0",
  "crispy-bootstrap3==2024.1",
  "crispy-bootstrap5==2025.6",
  "cryptography>=45.0.1",
  "cssselect>=1.3.0,<1.4",
  "cyrtranslit>=1.1.0,<1.2.0",
  "Cython>=3.1.0,<3.2",
  "dateparser>=1.2.0,<1.3.0",
  "diff-match-patch==20241021",
  "disposable-email-domains>=0.0.125",
  "django-appconf>=1.1.0,<1.2",
  "django-celery-beat>=2.8.0,<2.9",
  "django-compressor>=4.5.1,<5",
  "django-cors-headers>=4.7.0,<4.9",
  "django-crispy-forms>=2.4,<2.5",
  "django-filter>=24.3,<25.2",
  "django-otp-webauthn>=0.6.0,<0.7",
  "django-otp>=1.6.0,<2.0",
  "django-redis>=6.0.0,<6.1",
  "Django[argon2]>=5.1.5,<5.3",
  "djangorestframework-csv>=3.0.2,<3.1",
  "djangorestframework>=3.16.0,<3.17",
  "docutils>=0.21.2,<0.23",
  "drf-spectacular[sidecar]>=0.28.0,<0.29",
  "drf-standardized-errors[openapi]>=0.14.1,<0.16",
  "filelock<4,>=3.18.0",
  "fluent.syntax>=0.19.0,<0.20",
  "GitPython>=3.1.43,<3.2",
  "hiredis>=3.1.0,<3.3",
  "html2text>=2025.4.15,<2025.4.16",
  "iniparse==0.5",
  "jsonschema>=4.23.0,<5",
  "lxml>=5.4.0,<6.1",
  "mistletoe>=1.4.0,<1.5",
  "nh3>=0.2.20,<0.4",
  "openpyxl>=3.1.0,<3.2",
  "packaging>=25,<26",
  "phply>=1.2.6,<1.3",
  "Pillow>=11.0.0,<12",
  "pycairo>=1.20.0",
  "Pygments>=2.19.0,<3.0",
  "PyGObject>=3.40.1,<3.53.0",
  "pyicumessageformat>=1.0.0,<1.1",
  "pyparsing>=3.2.0,<3.3",
  "python-dateutil>=2.8.2",
  "qrcode>=8.2,<8.3",
  "rapidfuzz>=3.12.1,<3.15",
  "redis>=5.2.0,<7.0.0",
  "regex>=2024.11.6,<2026",
  "requests>=2.32.2,<2.33",
  "ruamel.yaml>=0.18.0,<0.19.0",
  "sentry-sdk>=2.28.0,<3.0",
  "siphashc>=2.5,<3.0",
  "social-auth-app-django>=5.5.1,<6.0.0",
  "social-auth-core>=4.7.0,<5.0.0",
  "standardwebhooks>=1.0.0,<1.1",
  "tesserocr>=2.8.0,<2.9.0",
  "translate-toolkit>=3.16.0,<3.17",
  "translation-finder>=2.22,<3.0",
  "unidecode>=1.4.0,<1.5",
  "user-agents>=2.2.0,<2.3",
  "weblate-language-data>=2025.7",
  "weblate-schemas==2025.5"
]
description = "A web-based continuous localization system with tight version control integration"
keywords = [
  "gettext",
  "git",
  "i18n",
  "l10n",
  "mercurial",
  "translate"
]
license = "GPL-3.0-or-later"
license-files = ["LICENSE"]
name = "weblate"
requires-python = ">=3.11"
version = "5.13.3"

[project.optional-dependencies]
alibaba = [
  "aliyun-python-sdk-alimt>=3.2.0,<4.0.0",
  "aliyun-python-sdk-core>=2.16.0,<3.0.0"
]
all = [
  "weblate[alibaba,amazon,antispam,gerrit,gelf,google,ldap,mercurial,openai,postgres,zxcvbn]"
]
amazon = [
  "boto3>=1.38.0,<2.0"
]
antispam = [
  "python-akismet>=0.4.2,<0.5"
]
gelf = [
  "logging-gelf>=0.0.32,<0.1"
]
gerrit = [
  "git-review>=2.4.0,<2.6.0"
]
google = [
  "google-cloud-storage>=2.18.2,<3.4",
  "google-cloud-translate>=3.13.0,<4.0"
]
ldap = [
  "django-auth-ldap>=4.6.0,<6.0.0"
]
mercurial = [
  "mercurial>=6.8.0,<7.2"
]
mysql = [
  "mysqlclient>=2.1.1,<3"
]
openai = [
  "openai>=1.68.2,<2.0"
]
postgres = [
  "psycopg[binary]>=3.1.8,<4"
]
saml = [
  "python3-saml>=1.2.1"
]
saml2idp = [
  "djangosaml2idp==0.7.2"
]
wlhosted = [
  "wlhosted"
]
wllegal = [
  "wllegal>=2024.6"
]
wsgi = [
  "granian==2.5.2"
]
zxcvbn = [
  "django-zxcvbn-password-validator>=1.4.5,<1.6"
]

[project.readme]
content-type = "text/x-rst"
file = "README.rst"

[project.scripts]
weblate = "weblate.runner:main"
weblate-generate-secret-key = "weblate.utils.generate_secret_key:main"

[project.urls]
Documentation = "https://docs.weblate.org/"
Download = "https://weblate.org/download/"
Funding = "https://weblate.org/donate/"
Homepage = "https://weblate.org/"
"Issue Tracker" = "https://github.com/WeblateOrg/weblate/issues"
"Release Notes" = "https://docs.weblate.org/en/latest/changes.html"
"Source Code" = "https://github.com/WeblateOrg/weblate"
X = "https://x.com/WeblateOrg"

[tool.check-manifest]
ignore = [
  "*.json",
  "*.toml",
  "*.yaml",
  "*.yml",
  ".dclintrc",
  ".editorconfig",
  ".gitmodules",
  ".gitmodules",
  ".imgbotconfig",
  ".reuse/dep5",
  ".stylelintrc",
  ".weblate",
  ".well-known/*",
  ".yamllint.yml",
  "ci/*",
  "client/*",
  "client/*/*",
  "dev-docker/*",
  "dev-docker/*/*",
  "docs/*",
  "docs/*/*",
  "docs/*/*/*",
  "docs/*/*/*/*",
  "LICENSES/*",
  "rundev.sh",
  "scripts/*",
  "scripts/*/*",
  "scripts/*/*/*",
  "scripts/*/*/*/*"
]
ignore-bad-ideas = [
  "weblate/trans/tests/data/cs.mo"  # Test data
]

[tool.check-wheel-contents]
ignore = [
  "W002",  # Triggered by __init__.py or .license files
  "W004"  # Django migrations fail here
]

[tool.codespell]
builtin = "clear,rare,informal,usage"
count = true
dictionary = "scripts/codespell.txt,-"
# Vai is a language name
ignore-words-list = "assertIn,Vai,master"
skip = '*.po,*.pot,*.json,*.tmx,*.tbx,*.csv,*/vendor/*,weblate/trans/specialchars.py,weblate/trans/tests/data/known_hosts,docs/changes/contributors/*.rst'

[tool.coverage.paths]
source = [
  "."
]

[tool.coverage.report]
exclude_also = [
  "@(abc\\.)?abstractmethod",
  # Don't complain about missing debug-only code:
  "def __repr__",
  # Don't complain if non-runnable code isn't run:
  "if 0:",
  "if __name__ == .__main__.:",
  "if self\\.debug",
  # Type checking
  "if TYPE_CHECKING:",
  # Have to re-enable the standard pragma
  "pragma: no cover",
  # Don't complain if tests don't hit defensive assertion code:
  "raise AssertionError",
  "raise NotImplementedError"
]

[tool.coverage.run]
branch = true
concurrency = ["multiprocessing", "thread"]
omit = [
  ".venv*/*",
  "weblate/settings.py",
  "weblate/settings_*.py"
]

[tool.django-stubs]
django_settings_module = "weblate.settings_test"
strict_settings = false

[tool.djlint]
blank_line_after_tag = "load,extends,endblock"
# This is actually tmx formatting:
custom_html = "tmx,header,body,tuv,tu,seg"
# - reconsider H014 once formatter is in use
# T003 - Endblock should have name.
# T002 - Double quotes should be used in tags. (makes using tags in attributes hard)
# H013 - Img tag should have an alt attribute.
# H006 - Img tag should have height and width attributes.
# H021 - Inline styles should be avoided.
# H031 - Consider adding meta keywords.
ignore = "T003,H014,T002,H013,H006,H021,H031"
indent = 2
max_attribute_length = 80
max_blank_lines = 2
preserve_blank_lines = true
profile = "django"

[tool.djlint.per-file-ignores]
# Mail templates need inline CSS and do not utilize description
"weblate/templates/mail/base.html" = "H030"
# Test file
"weblate/trans/tests/data/cs.html" = "H005,H007,H016,H030"

[tool.mypy]
check_untyped_defs = true
plugins = [
  "mypy_django_plugin.main",
  "mypy_drf_plugin.main"
]

[[tool.mypy.overrides]]
disallow_untyped_defs = true
ignore_missing_imports = true
module = [
  "akismet.*",
  "aliyunsdkalimt.*",
  "aliyunsdkcore.*",
  "appconf.*",
  "borg.*",
  "crispy_forms.*",
  "cyrtranslit.*",
  "debug_toolbar.*",
  "diff_match_patch.*",
  "django.db.backends.postgresql.psycopg_any",
  "django_auth_ldap.*",
  "django_celery_beat.*",
  "django_filters.*",
  "django_otp.*",
  "django_otp_webauthn.*",
  "django_redis.*",
  "djangosaml2idp.*",
  "google.oauth2.*",
  "icu.*",
  "ldap.*",
  "mistletoe.*",
  "pygments.*",
  "pyicumessageformat.*",
  "qrcode.*",
  "rest_framework_csv.*",
  "rollbar.*",
  "ruamel.*",
  "saml2.*",
  "simple_sso.*",
  "social_django.*",
  "tesserocr.*",
  "tinyunicodeblock.*",
  "user_agents.*",
  "wlhosted.*",
  "wllegal.*"
]

[tool.pydistcheck]
max_allowed_files = 2500
max_allowed_size_compressed = '100M'
max_allowed_size_uncompressed = '300M'

[tool.pylint.main]
disable = [
  "C",
  "c-extension-no-member",
  "I",
  "import-error",
  "invalid-str-returned",
  "no-member",
  "no-name-in-module",
  "not-a-mapping",
  "not-an-iterable",
  "not-callable",
  "R",
  "raising-bad-type",
  "unsubscriptable-object",
  "unsupported-binary-operation",
  "unsupported-membership-test",
  "W"
]
extension-pkg-whitelist = ["siphashc"]
ignore = [
  ".git",
  ".venv",
  "build",
  "migrations",
  "repos",
  "settings.py",
  "settings_test.py",
  "test-repos"
]

[tool.pytest.ini_options]
addopts = "--reuse-db --cov=weblate --cov-report= --durations=20 --durations-min=2 --ignore=data --ignore=data-test --ignore=dev-docker --ignore=scripts"
DJANGO_SETTINGS_MODULE = "weblate.settings_test"
FAIL_INVALID_TEMPLATE_VARS = true
python_files = ["test_*.py", "tests.py"]

[tool.ruff.format]
docstring-code-format = true

[tool.ruff.lint]
extend-safe-fixes = [
  "ANN",
  "D",
  "EM101",
  "FA102",
  "FLY",
  "SIM",
  "TCH",
  "UP"
]
# CONFIG - intentional configuration
# TODO - needs decision whether intention, add noqa tags or fix
# WONTFIX - not fixable in current codebase, might be better to go for noqa
ignore = [
  "A005",  # WONTFIX: Module is shadowing a Python builtin module
  "ANN001",  # TODO: Missing type annotation for function argument
  "ANN002",  # TODO: Missing type annotation for `*args`
  "ANN003",  # TODO: Missing type annotation for `**kwargs`
  "ANN201",  # TODO: Missing return type annotation for public function
  "ANN202",  # TODO:  Missing return type annotation for private function
  "ANN204",  # TODO: Missing return type annotation for special method
  "ANN205",  # TODO: Missing return type annotation for staticmethod
  "ANN206",  # TODO: Missing return type annotation for classmethod
  "ARG001",  # TODO: Unused function argument (mostly for API compatibility)
  "ARG002",  # TODO: Unused method argument (mostly for API compatibility)
  "BLE001",  # WONTFIX: Do not catch blind exception: `Exception`, third-party modules do not have defined exceptions
  "COM",  # CONFIG: No trailing commas
  "D100",  # TODO: Missing docstring in public module
  "D101",  # TODO: Missing docstring in public class
  "D102",  # TODO: Missing docstring in public method
  "D103",  # TODO: Missing docstring in public function
  "D104",  # TODO: Missing docstring in public package
  "D105",  # TODO: Missing docstring in magic method
  "D106",  # TODO: Missing docstring in public nested class
  "D107",  # TODO: Missing docstring in `__init__`
  "D203",  # CONFIG: incompatible with D211
  "D206",  # CONFIG: formatter
  "D212",  # CONFIG: incompatible with D213
  "DOC",  # TODO: Ignore all pydoclint rules for now
  "E203",  # CONFIG: formatter
  "E501",  # WONTFIX: we accept long strings (rest is formatted by black)
  "FBT",  # TODO: Boolean in function definition
  "FIX002",  # CONFIG: we use TODO
  "FURB101",  # TODO:  `open` and `read` should be replaced by `Path(hostsfile).read_text()`
  "FURB103",  # TODO: `open` and `write` should be replaced by `Path(name).write_text(content)`
  "PERF203",  # WONTFIX: This rule is only enforced for Python versions prior to 3.11
  "PLC0415",  # TODO: `import` should be at the top-level of a file
  "PLR2004",  # TODO: Magic value used in comparison, consider replacing 201 with a constant variable
  "PLR6301",  # TODO: Method could be a function, class method, or static method
  "PLW1514",  # TODO: `open` in text mode without explicit `encoding` argument
  "PLW2901",  # TODO: overwriting variables inside loop
  "PT",  # CONFIG: Not using pytest
  "PTH",  # TODO: Not using pathlib
  "RUF001",  # WONTFIX: String contains ambiguous unicode character, we are using Unicode
  "RUF012",  # TODO: Mutable class attributes should be annotated with `typing.ClassVar`
  "S404",  # CONFIG: `subprocess` module is possibly insecure
  "S603",  # CONFIG: `subprocess` call: check for execution of untrusted input
  "S607",  # CONFIG: executing system installed tools
  "TD002",  # CONFIG: no detailed TODO documentation is required
  "TD003",  # CONFIG: no detailed TODO documentation is required
  "TRY003",  # WONTFIX: Avoid specifying long messages outside the exception class
  'ISC001',  # CONFIG: formatter
  'Q000',  # CONFIG: formatter
  'Q001',  # CONFIG: formatter
  'Q002',  # CONFIG: formatter
  'Q003',  # CONFIG: formatter
  'W191'  # CONFIG: formatter
]
preview = true
select = ["ALL"]
task-tags = ["spellchecker"]

[tool.ruff.lint.flake8-copyright]
min-file-size = 2
# Copyright without a year, see https://github.com/astral-sh/ruff/issues/10062
notice-rgx = "(?i)Copyright\\s+©\\s+"

[tool.ruff.lint.mccabe]
max-complexity = 16  # TODO: should be lower

[tool.ruff.lint.per-file-ignores]
"docs/_ext/djangodocs.py" = ["INP001"]
"docs/conf.py" = ["ERA001", "INP001"]
"scripts/*" = ["T201", "T203"]
"weblate/*/tests**.py" = ["ANN001", "S105", "S106"]
"weblate/auth/migrations/0003_fixup_teams.py" = ["T201"]
"weblate/examples/*.py" = ["CPY001", "INP001"]
"weblate/settings_*.py" = ["F405"]
"weblate/settings_example.py" = ["ERA001"]
"weblate/utils/generate_secret_key.py" = ["T201"]

[tool.ruff.lint.pylint]
# TODO: all these should be lower (or use defaults)
max-args = 12
max-bool-expr = 8
max-branches = 36
max-locals = 23
max-nested-blocks = 9
max-positional-args = 8
max-public-methods = 180
max-returns = 21
max-statements = 100

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

[tool.setuptools.packages.find]
include = ["weblate*"]
namespaces = true

[tool.tomlsort]
ignore_case = true
sort_inline_arrays = true
sort_inline_tables = true
sort_table_keys = true
spaces_before_inline_comment = 2

[tool.typos.default]
extend-ignore-re = [
  "(?Rm)^.*# codespell:ignore.*$",
  "(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"
]

[tool.typos.default.extend-identifiers]
# TODO: Most of these should be probably fixed, but it requires a database migration
ApprovedStringNotificaton = "ApprovedStringNotificaton"
ChangedStringNotificaton = "ChangedStringNotificaton"
ComponentTranslatedNotificaton = "ComponentTranslatedNotificaton"
gir1 = "gir1"  # GObject Introspection packages
InexistantFiles = "InexistantFiles"
LangaugeConsistencyAddon = "LangaugeConsistencyAddon"  # Already deprecated, pending removal
LanguageTranslatedNotificaton = "LanguageTranslatedNotificaton"
LastAuthorCommentNotificaton = "LastAuthorCommentNotificaton"
MentionCommentNotificaton = "MentionCommentNotificaton"
NewAlertNotificaton = "NewAlertNotificaton"
NewAnnouncementNotificaton = "NewAnnouncementNotificaton"
NewCommentNotificaton = "NewCommentNotificaton"
NewComponentNotificaton = "NewComponentNotificaton"
NewContributorNotificaton = "NewContributorNotificaton"
NewStringNotificaton = "NewStringNotificaton"
NewSuggestionNotificaton = "NewSuggestionNotificaton"
NewTranslationNotificaton = "NewTranslationNotificaton"
RTO = "RTO"  # Recovery Time Objective acronym
TranslatedStringNotificaton = "TranslatedStringNotificaton"
Vai = "Vai"  # Language name

[tool.typos.default.extend-words]
# Name
Automattic = "Automattic"
# Used in settings, but could be fixed
COMMITER = "COMMITER"  # codespell:ignore
# Open Document Format acronym
ODF = "ODF"
# Often misspelled Weblate variants
webalte = "Weblate"  # codespell:ignore
webplate = "Weblate"
welbate = "Weblate"

[tool.typos.files]
extend-exclude = [
  "**.map",
  "**.po",
  "**.pot",
  "docs/changes/contributors",
  "docs/specs",
  "scripts/codespell.txt",
  "scripts/spdx-license-list",
  "weblate/static/js/vendor",
  "weblate/static/vendor",
  "weblate/trans/fixtures/simple-project.json",
  "weblate/trans/specialchars.py",
  "weblate/trans/tests/data",
  "weblate/utils/licensedata.py"
]