Skip to content

Structure

structure

Audit checks for project structure (7 checks, 17 pts).

check_contributing(project)

Check 27: CONTRIBUTING.md exists.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def check_contributing(project: Path) -> CheckResult:
    """Check 27: CONTRIBUTING.md exists."""
    if not (project / "CONTRIBUTING.md").exists():
        return CheckResult(
            name="structure.contributing",
            category="structure",
            passed=False,
            weight=2,
            message="CONTRIBUTING.md not found",
            details=[],
            fix="Create CONTRIBUTING.md with dev setup and commit conventions.",
        )
    return CheckResult(
        name="structure.contributing",
        category="structure",
        passed=True,
        weight=2,
        message="CONTRIBUTING.md found",
        details=[],
        fix="",
    )

check_license_file(project)

Check 28: LICENSE file exists.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
def check_license_file(project: Path) -> CheckResult:
    """Check 28: LICENSE file exists."""
    if not (project / "LICENSE").exists():
        return CheckResult(
            name="structure.license",
            category="structure",
            passed=False,
            weight=3,
            message="LICENSE file not found",
            details=[],
            fix="Create a LICENSE file (MIT, Apache-2.0, or EUPL-1.2).",
        )
    return CheckResult(
        name="structure.license",
        category="structure",
        passed=True,
        weight=3,
        message="LICENSE file found",
        details=[],
        fix="",
    )

check_py_typed(project)

Check 25: py.typed marker in package.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
 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
def check_py_typed(project: Path) -> CheckResult:
    """Check 25: py.typed marker in package."""
    src = project / "src"
    if not src.is_dir():
        return CheckResult(
            name="structure.py_typed",
            category="structure",
            passed=False,
            weight=2,
            message="src/ directory not found",
            details=[],
            fix="Create src/<package_name>/py.typed marker file.",
        )
    packages = _find_packages(src)
    for pkg in packages:
        if (pkg / "py.typed").exists():
            return CheckResult(
                name="structure.py_typed",
                category="structure",
                passed=True,
                weight=2,
                message="py.typed marker found",
                details=[],
                fix="",
            )
    return CheckResult(
        name="structure.py_typed",
        category="structure",
        passed=False,
        weight=2,
        message="py.typed marker not found",
        details=["PEP 561: py.typed marks package as providing type information"],
        fix="Create an empty src/<package_name>/py.typed file.",
    )

check_python_version(project)

Check 33: .python-version file exists.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def check_python_version(project: Path) -> CheckResult:
    """Check 33: .python-version file exists."""
    if not (project / ".python-version").exists():
        return CheckResult(
            name="structure.python_version",
            category="structure",
            passed=False,
            weight=1,
            message=".python-version not found",
            details=["Pin Python version for consistent environments"],
            fix="Run `uv python pin 3.12` to create .python-version.",
        )
    return CheckResult(
        name="structure.python_version",
        category="structure",
        passed=True,
        weight=1,
        message=".python-version found",
        details=[],
        fix="",
    )

check_src_layout(project)

Check 24: src// layout with init.py.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
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
def check_src_layout(project: Path) -> CheckResult:
    """Check 24: src/<pkg>/ layout with __init__.py."""
    src = project / "src"
    if not src.is_dir():
        return CheckResult(
            name="structure.src_layout",
            category="structure",
            passed=False,
            weight=4,
            message="src/ directory not found",
            details=["Expected: src/<package_name>/__init__.py"],
            fix="Migrate to src/ layout: move package into src/<package_name>/.",
        )
    packages = _find_packages(src)
    if not packages:
        return CheckResult(
            name="structure.src_layout",
            category="structure",
            passed=False,
            weight=4,
            message="No Python package found in src/",
            details=["src/ exists but contains no package with __init__.py"],
            fix="Create src/<package_name>/__init__.py.",
        )
    pkg_names = sorted(d.relative_to(src).as_posix() for d in packages)
    return CheckResult(
        name="structure.src_layout",
        category="structure",
        passed=True,
        weight=4,
        message=f"src/ layout with {len(packages)} package(s)",
        details=[f"packages: {', '.join(pkg_names)}"],
        fix="",
    )

check_tests_dir(project)

Check 26: tests/ directory with unit/integration/e2e pyramid.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def check_tests_dir(project: Path) -> CheckResult:
    """Check 26: tests/ directory with unit/integration/e2e pyramid."""
    tests = project / "tests"
    if not tests.is_dir():
        return CheckResult(
            name="structure.tests_dir",
            category="structure",
            passed=False,
            weight=3,
            message="tests/ directory not found",
            details=[],
            fix=(
                "Create tests/ directory with unit/, integration/, e2e/ subdirectories."
            ),
        )
    required = ["unit", "integration", "e2e"]
    missing = [sub for sub in required if not (tests / sub).is_dir()]
    if missing:
        missing_paths = [f"tests/{sub}/" for sub in missing]
        return CheckResult(
            name="structure.tests_dir",
            category="structure",
            passed=False,
            weight=3,
            message=f"Missing test pyramid subdirectories: {', '.join(missing_paths)}",
            details=[f"Expected: {p}" for p in missing_paths],
            fix=f"Create missing subdirectories: {', '.join(missing_paths)}",
        )
    test_files = list(tests.rglob("test_*.py"))
    if not test_files:
        return CheckResult(
            name="structure.tests_dir",
            category="structure",
            passed=False,
            weight=3,
            message="No test files found in tests/",
            details=["Expected: tests/{unit,integration,e2e}/test_*.py files"],
            fix=(
                "Add test files matching test_*.py pattern under"
                " tests/unit/, tests/integration/, or tests/e2e/."
            ),
        )
    return CheckResult(
        name="structure.tests_dir",
        category="structure",
        passed=True,
        weight=3,
        message=f"{len(test_files)} test file(s) found across unit/integration/e2e",
        details=[],
        fix="",
    )

check_uv_lock(project)

Check 32: uv.lock committed for reproducible builds.

Source code in packages/axm-init/src/axm_init/checks/structure.py
Python
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
def check_uv_lock(project: Path) -> CheckResult:
    """Check 32: uv.lock committed for reproducible builds."""
    lock = _find_uv_lock(project)
    if lock is None:
        return CheckResult(
            name="structure.uv_lock",
            category="structure",
            passed=False,
            weight=2,
            message="uv.lock not found",
            details=["Commit uv.lock for reproducible dependency resolution"],
            fix="Run `uv lock` and commit the generated uv.lock file.",
        )
    at_root = lock.parent != project.resolve()
    msg = "uv.lock found (workspace root)" if at_root else "uv.lock found"
    return CheckResult(
        name="structure.uv_lock",
        category="structure",
        passed=True,
        weight=2,
        message=msg,
        details=[],
        fix="",
    )