pyproject.toml

[project]
name = "django-boilerplate"
version = "0.1.0"
description = "DRF boilerplate project with linters and formatters."
dependencies = [
  "Django>=5.0",
  "python-dotenv>=1.0.1",
  "ruff",
  "djangorestframework==3.15.2",
  "django-filter==24.3",
  "drf-spectacular==0.27.2",
]
requires-python = ">=3.12"
readme = "README.md"

[project.urls]
Repository = "https://github.com/Azen0n/django-boilerplate"
Documentation = "https://github.com/Azen0n/django-boilerplate"

[tool.ruff]
line-length = 120
indent-width = 4
target-version = 'py312'
exclude = []

[tool.ruff.lint]
mccabe = { max-complexity = 14 }
select = [
  "F",       # pyflakes
  "E",       # pycodestyle errors
  "W",       # pycodestyle warnings
  "C90",     # mccabe
  "I",       # isort
  "N",       # pep8-naming
  "UP",      # pyupgrade
  "YTT",     # flake8-2020
  "S",       # flake8-bandit
  "BLE",     # flake8-blind-except
  "FBT003",  # flake8-boolean-trap
  "B",       # flake8-bugbear
  "COM",     # flake8-commas
  "C4",      # flake8-comprehensions
  "T10",     # flake8-debugger
  "ISC",     # flake8-implicit-str-concat
  "G010",    # Logging statement uses warn instead of warning
  "G201",    # Logging .exception(...) should be used instead of .error(..., exc_info=True)
  "G202",    # Logging statement has redundant exc_info
  "INP",     # flake8-no-pep420
  "PIE",     # flake8-pie
  "T20",     # flake8-print
  "PYI",     # flake8-pyi
  "PT",      # flake8-pytest-style
  "Q",       # flake8-quotes
  "RSE",     # flake8-raise
  "RET",     # flake8-return
  "SIM",     # flake8-simplify
  "TCH",     # flake8-type-checking
  "ARG",     # flake8-unused-arguments
  "PTH",     # flake8-use-pathlib
  "ERA",     # flake8-eradicate
  "LOG",     # flake8-logging
  "G",       # flake8-logging-format
  "PGH",     # pygrep-hooks
  "PLC0414", # Import alias does not rename original package
  "PLE",     # Error
  "PLW",     # Warning
  "TRY",     # tryceratops
  "FLY",     # flynt
  "RUF",     # ruff-specific rules
  "ANN001",  # missing type annotation for arguments
  "ANN002",  # missing type annotation for *args
  "ANN003",  # missing type annotation for **kwargs
]
unfixable = [
  "ERA001", # eradicate: found commented out code (can be dangerous if fixed automatically)
]
ignore = [
  "D203",   # 1 blank line required before class docstring
  "ARG001", # Unused first argument
  "ARG002", # Unused method argument
  "TRY003", # Avoid specifying long messages outside the exception class
  "TRY300", # Consider moving statement into the else clause
  "PT019",  # Fixture without value is injected as parameter, use @pytest.mark.usefixtures instead
  # (usefixtures doesn't play well with IDE features such as auto-renaming)
  "SIM108", # Use ternary operator instead of if-else block (ternaries lie to coverage)
  "RET505", # Unnecessary `else` after `return` statement
  "N805",   # First argument of a method should be named `self` (pydantic validators don't play well with this)

  # The following rules are recommended to be ignored by ruff when using ruff format
  "ISC001", # Checks for implicitly concatenated strings on a single line
  "ISC002", # Checks for implicitly concatenated strings that span multiple lines
  "W191",   # Checks for indentation that uses tabs
  "E111",   # Checks for indentation with a non-multiple of 4 spaces
  "E114",   # Checks for indentation of comments with a non-multiple of 4 spaces
  "E117",   # Checks for over-indented code
  "D206",   # Checks for docstrings that are indented with tabs
  "D300",   # Checks for docstrings that use '''single quotes''' instead of """double quotes"""
  "Q000",   # Checks for inline strings that use single quotes or double quotes
  "Q001",   # Checks for multiline strings that use single quotes or double quotes
  "Q002",   # Checks for docstrings that use single quotes or double quotes
  "Q003",   # Checks for strings that include escaped quotes
  "COM812", # Checks for the absence of trailing commas
  "COM819", # Checks for the presence of prohibited trailing commas
  "RET506", # Unnecessary `elif` after `raise` statement
]

[tool.ruff.format]
quote-style = "single"
indent-style = "space"
skip-magic-trailing-comma = false  # Respect magic trailing commas