action-style-guide/pyproject.toml at main · QuantEcon/action-style-guide · 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
[project]
name = "qestyle"
dynamic = ["version"]
description = "AI-powered style guide compliance checker for QuantEcon lecture materials"
requires-python = ">=3.11"
readme = "README.md"
license = {text = "MIT"}
authors = [
    {name = "QuantEcon"},
]
keywords = ["quantecon", "style-guide", "linter", "myst-markdown"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Education",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Topic :: Text Processing :: Markup :: Markdown",
]
# Core runtime dependency — the qestyle CLI only needs the Anthropic SDK.
dependencies = [
    "anthropic>=0.18.0",
]

[project.optional-dependencies]
# Extra dependencies needed by the GitHub Action entry point (action.py / github_handler.py)
# which talks to the GitHub API via PyGithub. The CLI does not need these.
action = [
    "PyGithub>=2.1.1",
]
# Dev/test tooling. Install with `uv sync --all-extras` or `pip install -e ".[dev]"`.
dev = [
    "pytest>=7.4.0",
    "pytest-cov>=4.1.0",
    "ruff",
]

[project.scripts]
qestyle = "style_checker.cli:main"

[project.urls]
Homepage = "https://github.com/QuantEcon/action-style-guide"
Repository = "https://github.com/QuantEcon/action-style-guide"
Issues = "https://github.com/QuantEcon/action-style-guide/issues"

[build-system]
requires = ["setuptools>=64"]
build-backend = "setuptools.build_meta"

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

[tool.setuptools.packages.find]
include = ["style_checker*"]

[tool.setuptools.package-data]
style_checker = ["prompts/*.md", "prompts/**/*.md", "rules/*.md"]

[tool.pytest.ini_options]
# Pytest configuration

# Test discovery patterns
python_files = "test_*.py"
python_classes = "Test*"
python_functions = "test_*"

# Test paths
testpaths = ["tests"]

# Output options
addopts = [
    "-v",                    # Verbose output
    "--strict-markers",      # Error on unknown markers
    "-m", "not integration", # Skip LLM integration tests by default (run with: pytest -m integration)
    "--tb=short",           # Shorter traceback format
    "--cov=style_checker",  # Coverage for style_checker module
    "--cov-report=term-missing",  # Show missing lines in coverage
    "--cov-report=html",    # Generate HTML coverage report
]

# Markers for categorizing tests
markers = [
    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
    "integration: marks tests as integration tests that call real LLM APIs",
    "unit: marks tests as unit tests",
]

# Ignore patterns
norecursedirs = [
    ".git",
    ".github",
    "*.egg-info",
    "__pycache__",
    "docs",
    "examples",
]

[tool.coverage.run]
# Coverage configuration
source = ["style_checker"]
omit = [
    "*/tests/*",
    "*/__pycache__/*",
    "*/site-packages/*",
]

[tool.coverage.report]
# Coverage reporting
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "raise AssertionError",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
    "@abstractmethod",
]