Skip to content

Commit 9561fb7

Browse files
committed
🔧 Add pyproject.toml config
1 parent 77197fa commit 9561fb7

File tree

2 files changed

+792
-0
lines changed

2 files changed

+792
-0
lines changed

pyproject.toml

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
[project]
2+
name = "annotated-doc"
3+
version = "0.0.1"
4+
description = "Document parameters, class attributes, return types, and variables inline, with Annotated."
5+
readme = "README.md"
6+
authors = [
7+
{ name = "Sebastián Ramírez", email = "[email protected]" }
8+
]
9+
requires-python = ">=3.8"
10+
classifiers = [
11+
"Intended Audience :: Information Technology",
12+
"Intended Audience :: System Administrators",
13+
"Operating System :: OS Independent",
14+
"Programming Language :: Python :: 3",
15+
"Programming Language :: Python",
16+
"Topic :: Internet",
17+
"Topic :: Software Development :: Libraries :: Application Frameworks",
18+
"Topic :: Software Development :: Libraries :: Python Modules",
19+
"Topic :: Software Development :: Libraries",
20+
"Topic :: Software Development",
21+
"Typing :: Typed",
22+
"Development Status :: 4 - Beta",
23+
"Intended Audience :: Developers",
24+
"License :: OSI Approved :: MIT License",
25+
"Programming Language :: Python :: 3 :: Only",
26+
"Programming Language :: Python :: 3.8",
27+
"Programming Language :: Python :: 3.9",
28+
"Programming Language :: Python :: 3.10",
29+
"Programming Language :: Python :: 3.11",
30+
"Programming Language :: Python :: 3.12",
31+
"Programming Language :: Python :: 3.13",
32+
"Programming Language :: Python :: 3.14",
33+
]
34+
dependencies = []
35+
[project.urls]
36+
Homepage = "https://github.com/fastapi/annotated-doc"
37+
Documentation = "https://github.com/fastapi/annotated-doc"
38+
Repository = "https://github.com/fastapi/annotated-doc"
39+
Issues = "https://github.com/fastapi/annotated-doc/issues"
40+
Changelog = "https://github.com/fastapi/annotated-doc/release-notes.md"
41+
42+
[build-system]
43+
requires = ["uv_build>=0.9.1,<0.10.0"]
44+
build-backend = "uv_build"
45+
46+
[tool.mypy]
47+
strict = true
48+
49+
[tool.pytest.ini_options]
50+
addopts = [
51+
"--strict-config",
52+
"--strict-markers",
53+
]
54+
xfail_strict = true
55+
junit_family = "xunit2"
56+
57+
[tool.coverage.run]
58+
parallel = true
59+
data_file = "coverage/.coverage"
60+
source = [
61+
"src",
62+
]
63+
context = '${CONTEXT}'
64+
dynamic_context = "test_function"
65+
66+
[tool.coverage.report]
67+
show_missing = true
68+
sort = "-Cover"
69+
70+
[tool.coverage.html]
71+
show_contexts = true
72+
73+
[tool.ruff.lint]
74+
select = [
75+
"E", # pycodestyle errors
76+
"W", # pycodestyle warnings
77+
"F", # pyflakes
78+
"I", # isort
79+
"B", # flake8-bugbear
80+
"C4", # flake8-comprehensions
81+
"UP", # pyupgrade
82+
]
83+
ignore = [
84+
"E501", # line too long, handled by black
85+
"B008", # do not perform function calls in argument defaults
86+
"C901", # too complex
87+
"W191", # indentation contains tabs
88+
]
89+
90+
[tool.ruff.lint.pyupgrade]
91+
# Preserve types, even if a file imports `from __future__ import annotations`.
92+
keep-runtime-typing = true
93+
94+
[dependency-groups]
95+
dev = [
96+
"coverage>=7.6.1",
97+
"mypy>=1.14.1",
98+
"pytest>=8.3.5",
99+
"ruff>=0.14.1",
100+
]

0 commit comments

Comments
 (0)