pyproject.toml

[project]
version = "0.1.0"
name = "royal_game"
authors = [
    {email = "casperg@umich.edu", name = "Casper Guo"},
]
description = "Royal Game of Ur Simulator"
readme = "README.md"
requires-python = ">=3.10"
dependencies=["click>=8.0.0"]

[build-system]
requires = ["setuptools >= 61.0", "click >= 8.0.0"]
build-backend = "setuptools.build_meta"

[tool.ruff]
line-length = 96
indent-width = 4
exclude = [
    "royal_game/__init__.py",
]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"

[tool.ruff.lint]
select = [
    # Pyflakes
    "F",
    # pycodestyle warnings
    "W",
    # pycodestyle errors
    "E",
    # isort
    "I",
    # pep8-naming
    "N",
    # pydocstyle
    "D1",
    "D2",
    "D3",
    "D400",
    "D401",
    "D402",
    "D403",
    "D404",
    # flake8-blind-except
    "BLE",
    # flake8-builtins
    "A",
    # flake8-logging-format
    "G",
    # flake8-raise
    "RSE",
    # flake8-return
    "RET",
    # flake8-simplify
    "SIM",
    # flake8-use-pathlib
    "PTH",
]
ignore = ["D105", "D107", "D203", "D212", "PTH123"]

[tool.ruff.lint.per-file-ignores]
# ignores docstring requirements for test files
"royal_game/tests/**.py" = ["D"]
"test_translate.py" = ["D"]
# ignores requirement for exception classes to end in 'Error'
"royal_game/_exceptions.py" = ["N818", "D"]