synthdocs/pyproject.toml at main · soetang/synthdocs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
[project]
name = "synthdocs"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
authors = [
    { name = "Benjamin", email = "benjamin@soetang.dk" }
]
requires-python = ">=3.10"
dependencies = [
    "jinja2>=3.1.6",
    "mistralai>=1.0.0",
    "openai>=1.0.0",
    "pydantic>=2.0.0",
]

[project.optional-dependencies]
dev = [
    "mypy>=1.0.0",
    "pytest>=7.0.0",
    "ruff>=0.1.0",
]
viewer = [
    "shiny>=1.0.0",
]

[project.scripts]
synthdocs = "synthdocs.cli.main:main"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build.targets.wheel]
packages = ["src/synthdocs"]

[tool.pytest.ini_options]
pythonpath = [
  "src",
]

[tool.ruff]
line-length = 88
target-version = "py310"

[tool.ruff.lint]
select = [
    "E",      # pycodestyle errors
    "W",      # pycodestyle warnings
    "F",      # Pyflakes
    "I",      # isort
    "D",      # pydocstyle - docstring checks
]
ignore = [
    "D100",   # Missing docstring in public module - not always needed
    "D104",   # Missing docstring in public package - __init__.py doesn't always need docs
    "D105",   # Missing docstring in magic method - __repr__ etc. are self-explanatory
    "D107",   # Missing docstring in __init__ - class docstring is usually sufficient
]

[tool.ruff.lint.per-file-ignores]
# Tests don't need docstrings for every function/method - test names are descriptive
"tests/*" = ["D102", "D103"]

[tool.ruff.lint.pydocstyle]
# Enforce Google-style docstrings
convention = "google"