pyproject.toml

##
# Project settings
##

[project]

name = "ranger-ims-server"
dynamic = ["version"]
description = "Ranger Incident Management System"
readme = "README.rst"
license = {file = "LICENSE.txt"}

# Requirements
requires-python = ">=3.13"
dependencies = [
    "arrow==1.3.0",
    "attrs==24.3.0",
    "bcrypt==4.2.1",
    "cattrs==24.1.2",
    "cryptography==44.0.0",
    "hyperlink==21.0.0",
    "jwcrypto==1.5.6",
    "klein==24.8.0",
    "pymysql==1.1.1",
    "pyopenssl==24.3.0",
    "pyyaml==6.0.2",
    "service-identity==24.2.0",
    "twisted==24.11.0",
    "werkzeug==3.1.3",
    "zope-interface==7.2",
]

# Authors/maintainers
authors = [
    {name="Wilfredo Sánchez Vega", email="tool@burningman.org"},
]
maintainers = [
  {name = "Burning Man Project, Black Rock Rangers", email = "ranger-tech-ninjas@burningman.org"},
]

# Search metadata
classifiers = [
    "Framework :: Twisted",
    "Intended Audience :: Information Technology",
    "Intended Audience :: Other Audience",
    "License :: OSI Approved :: Apache Software License",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3.13",
    "Topic :: Office/Business",
]
keywords = ["incident management", "ranger"]


[project.scripts]
ims = "ims.run:Command.main"


[project.urls]
Homepage = "https://github.com/burningmantech/ranger-ims-server"
#Documentation = ""
Repository = "https://github.com/burningmantech/ranger-ims-server.git"
Issues = "https://github.com/burningmantech/ranger-ims-server/issues"
Changelog = "https://github.com/burningmantech/ranger-ims-server/blob/master/CHANGELOG.md"


[build-system]

requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"


##
# Ruff
##

[tool.ruff.format]

# skip-magic-trailing-comma = true


[tool.ruff.lint]

select = ["ALL"]
ignore = [
    "A001",     # Variable `min` is shadowing a Python builtin
    "A002",     # Function argument is shadowing a Python builtin
    "A004",     # Import is shadowing a Python builtin
    "ANN401",   # Dynamically typed expressions (typing.Any) are disallowed
    "ARG002",   # Unused method argument
    "B008",     # Do not perform function call in argument defaults
    "C901",     # is too complex
    "COM812",   # Trailing comma missing
    "D105",     # Missing docstring in magic method
    "D200",     # One-line docstring should fit on one line
    "D202",     # No blank lines allowed after function docstring
    "D203",     # Use a blank line to separate the docstring from the class definition
    "D205",     # 1 blank line required between summary line and description
    "D212",     # Multi-line docstring summary should start at the first line
    "D213",     # Multi-line docstring summary should start at the second line
    "D400",     # First line should end with a period
    "D401",     # First line of docstring should be in imperative mood
    "D415",     # First line should end with a period, question mark, or exclamation point
    "DTZ001",   # `datetime.datetime()` called without a `tzinfo` argument
    "DTZ005",   # `datetime.datetime.now()` called without a `tz` argument
    "EM101",    # Exception must not use a string literal, assign to variable first
    "EM102",    # Exception must not use an f-string literal, assign to variable first
    "ERA001",   # Found commented-out code
    "FIX001",   # Line contains FIXME, consider resolving the issue
    "ISC001",   # Implicitly concatenated strings on a single line  # Disabled for formatter compatibility
    "N802",     # Function name should be lowercase
    "N803",     # Argument name should be lowercase
    "N806",     # Variable in function should be lowercase
    "N812",     # Lowercase imported as non-lowercase
    "N815",     # Variable in class scope should not be mixedCase
    "N816",     # Variable in global scope should not be mixedCase
    "PIE796",   # Enum contains duplicate value: `str`
    "PLR0911",  # Too many return statements
    "PLR0912",  # Too many branches
    "PLR0913",  # Too many arguments in function definition
    "PLR0915",  # Too many statements
    "PT",       # We don't use pytest
    "RSE102",   # Unnecessary parentheses on raised exception
    "S101",     # Use of `assert` detected
    "S608",     # Possible SQL injection vector through string-based query construction

    # Reconsider
    "TID252",   # Prefer absolute imports over relative imports from parent modules

    # TODO
    "FBT001",   # Boolean-typed positional argument in function definition
    "FBT002",   # Boolean default positional argument in function definition
    "FBT003",   # Boolean positional value in function call
    "SIM102",   # Use a single `if` statement instead of nested `if` statements
    "SIM105",   # Use `contextlib.suppress(NoSectionError, NoOptionError)` instead of `try`-`except`-`pass`
    "SIM108",   # Use ternary operator
    "SIM114",   # Combine `if` branches using logical `or` operator
    "SIM115",   # Use a context manager for opening files
    "SIM118",   # Use `key in dict` instead of `key in dict.keys()`
    "SLF001",   # Private member accessed
    "T201",     # `print` found
    "T203",     # `pprint` found
    "TC001",    # Move application import into a type-checking block
    "TC003",    # Move standard library import into a type-checking block
    "TD001",    # Invalid TODO tag: `FIXME`
    "TD002",    # Missing author in TODO
    "TD003",    # Missing issue link on the line following this TODO
    "TRY003",   # Avoid specifying long messages outside the exception class
    "TRY301",   # Abstract `raise` to an inner function
    "TRY400",   # Use `logging.exception` instead of `logging.error`
    "UP006",    # Use `collections.deque` instead of `Deque` for type annotation
    "UP007",    # Use `X | Y` for type annotations
    "UP017",    # Use `datetime.UTC` alias
    "UP031",    # Use format specifiers instead of percent format
    "UP032",    # Use f-string instead of `format` call
    "UP035",    # `typing.Deque` is deprecated, use `collections.deque` instead
    "UP038",    # Use `X | Y` in `isinstance` call instead of `(X, Y)`
]

[tool.ruff.lint.isort]

lines-after-imports = 2


##
# Setuptools
##

[tool.setuptools.dynamic]
version = {attr = "ims.__version__"}

[tool.setuptools.packages.find]
where = ["src"]


##
# uv
##

[tool.uv]

default-groups = []
[dependency-groups]
unit = [
    "coverage==7.6.1",
    "docker==7.1.0",
    "hypothesis==6.112.4",
    "mock==5.1.0",
]
mypy = [
    "mypy-zope==1.0.9",
    "mypy==1.13.0",
    "types-pymysql==1.1.0.20240524",
    "types-pyyaml==6.0.12.20240917",
]