ProjectAtlas API

This document is generated by scripts/generate_api_docs.py.

__init__.py

Purpose: Define the ProjectAtlas package metadata.

__main__.py

Purpose: Allow python -m projectatlas to run the CLI.

atlas.py

Purpose: Scan repositories and build ProjectAtlas record entries.

Function is_excluded_rel_path

Check whether a relative path should be excluded.

Function file_extension

Return a normalized file extension, handling .d.ts specially.

Function is_source_file

Check whether a file should be scanned for Purpose headers.

Function iter_repo_paths

Walk the repo and return tracked folders and source files.

Function iter_repo_paths_with_untracked

Walk the repo and return tracked and untracked paths.

Function normalize_summary

Normalize a Purpose summary to a single spaced line.

Function summarize_extensions

Summarize extensions for a sequence of file paths.

Function is_under_prefix

Check whether a path is under any of the provided prefixes.

Function is_allowed_untracked

Check whether an untracked path is allowed by policy.

Function is_asset_file

Check whether a file is considered an asset.

Function list_existing_asset_roots

List asset root prefixes that exist in the repo.

Function strip_line_comment_prefix

Remove the first matching line-comment prefix and trim whitespace.

Function extract_purpose_from_lines

Extract the Purpose summary from a sequence of lines.

Function extract_javadoc_purpose

Extract Purpose from a Javadoc-style header block.

Function extract_block_comment_purpose

Extract Purpose from a block comment header.

Function extract_python_docstring_purpose

Extract Purpose from a Python module docstring.

Function extract_vue_purpose

Extract Purpose from the first Vue