standardize packaging, tooling, docs, CI, and licensing
This commit is contained in:
126
pyproject.toml
126
pyproject.toml
@@ -17,6 +17,19 @@ authors = [
|
||||
maintainers = [
|
||||
{ name = "Aetos Skia", email = "dev@aetoskia.com" }
|
||||
]
|
||||
|
||||
|
||||
keywords = [
|
||||
"documentation",
|
||||
"docs",
|
||||
"compiler",
|
||||
"mkdocs",
|
||||
"mcp",
|
||||
"griffe",
|
||||
"docstrings",
|
||||
"sphinx",
|
||||
]
|
||||
|
||||
classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
@@ -25,9 +38,12 @@ classifiers = [
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Framework :: FastAPI",
|
||||
"Topic :: Software Development :: Libraries",
|
||||
"Topic :: Internet :: WWW/HTTP :: HTTP Servers",
|
||||
"Topic :: Documentation",
|
||||
"Typing :: Typed",
|
||||
]
|
||||
|
||||
|
||||
@@ -57,14 +73,25 @@ sphinx = [
|
||||
"sphinx-autodoc-typehints>=1.19.0",
|
||||
]
|
||||
mcp = [
|
||||
"mcp>=1.0.0",
|
||||
"mcp>=1.0.0,<2.0.0",
|
||||
]
|
||||
dev = [
|
||||
"pytest>=7.0.0",
|
||||
"pytest-cov>=4.0.0",
|
||||
"pytest>=8.0.0",
|
||||
"pytest-asyncio>=0.21.0",
|
||||
"pytest-cov>=4.1.0",
|
||||
"black>=23.0.0",
|
||||
"ruff>=0.1.0",
|
||||
"mypy>=1.0.0",
|
||||
"ruff>=0.3.0",
|
||||
"mypy>=1.8.0",
|
||||
"build>=1.0.0",
|
||||
"twine>=4.0.0",
|
||||
"pre-commit>=3.4.0",
|
||||
]
|
||||
docs = [
|
||||
"doc-forge[mkdocs]",
|
||||
]
|
||||
|
||||
all = [
|
||||
"doc-forge[dev,docs,mcp]",
|
||||
]
|
||||
|
||||
|
||||
@@ -80,15 +107,100 @@ Versions = "https://git.aetoskia.com/aetos/doc-forge/tags"
|
||||
packages = { find = { include = ["docforge*"] } }
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
docforge = ["templates/*.yml"]
|
||||
docforge = ["py.typed", "templates/*.yml"]
|
||||
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
testpaths = ["tests"]
|
||||
asyncio_mode = "auto"
|
||||
python_files = ["test_*.py"]
|
||||
python_classes = ["Test*"]
|
||||
python_functions = ["test_*"]
|
||||
addopts = [
|
||||
"--strict-markers",
|
||||
"--strict-config",
|
||||
"--cov=docforge",
|
||||
"--cov-report=term-missing",
|
||||
"--cov-report=html",
|
||||
"--cov-report=xml",
|
||||
]
|
||||
|
||||
|
||||
[tool.black]
|
||||
line-length = 88
|
||||
target-version = ["py310", "py311", "py312", "py313"]
|
||||
include = '\.pyi?$'
|
||||
extend-exclude = '''
|
||||
/(
|
||||
\.eggs
|
||||
| \.git
|
||||
| \.hg
|
||||
| \.mypy_cache
|
||||
| \.tox
|
||||
| \.venv
|
||||
| build
|
||||
| dist
|
||||
)/
|
||||
'''
|
||||
|
||||
|
||||
[tool.ruff]
|
||||
line-length = 100
|
||||
line-length = 88
|
||||
target-version = "py310"
|
||||
|
||||
[tool.ruff.lint]
|
||||
select = [
|
||||
"E",
|
||||
"W",
|
||||
"F",
|
||||
"I",
|
||||
"B",
|
||||
"C4",
|
||||
"UP",
|
||||
]
|
||||
ignore = [
|
||||
"E501",
|
||||
"B008",
|
||||
"C901",
|
||||
]
|
||||
|
||||
[tool.ruff.lint.per-file-ignores]
|
||||
"__init__.py" = ["F401", "I001"]
|
||||
"tests/*" = ["B008"]
|
||||
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.10"
|
||||
strict = true
|
||||
exclude = [
|
||||
"tests/",
|
||||
]
|
||||
files = ["docforge"]
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = [
|
||||
"griffe.*",
|
||||
"mcp.*",
|
||||
"click",
|
||||
"pydantic",
|
||||
]
|
||||
ignore_missing_imports = true
|
||||
|
||||
|
||||
[tool.coverage.run]
|
||||
source = ["docforge"]
|
||||
omit = [
|
||||
"*/tests/*",
|
||||
"*/test_*.py",
|
||||
]
|
||||
|
||||
[tool.coverage.report]
|
||||
exclude_lines = [
|
||||
"pragma: no cover",
|
||||
"def __repr__",
|
||||
"if __name__ == .__main__.:",
|
||||
"raise AssertionError",
|
||||
"raise NotImplementedError",
|
||||
"if TYPE_CHECKING:",
|
||||
"@abstractmethod",
|
||||
]
|
||||
Reference in New Issue
Block a user