Skip to content

project-module.md

Latest commit

 

History

History
86 lines (59 loc) · 2.4 KB

project-module.md

File metadata and controls

86 lines (59 loc) · 2.4 KB

Project Module

Multi-project discovery, validation, and metadata extraction

Location: infrastructure/project/
Quick Reference: Modules Guide | API Reference

Key Features

  • Project Discovery: Automatically finds valid projects by scanning for manuscript/config.yaml
  • Structure Validation: Verifies project directories have required src/, tests/, manuscript/ structure
  • Metadata Extraction: Reads project configuration (title, authors, DOI, testing thresholds)
  • Multi-Project Support: Enables N independent projects within a single repository

Usage Examples

Discover Active Projects

from pathlib import Path
from infrastructure.project import discover_projects

# Discover all projects under projects/
projects = discover_projects(Path("."))
for project in projects:
    print(f"{project.name}: {project.path}")

Validate Project Structure

from pathlib import Path
from infrastructure.project import validate_project_structure

result = validate_project_structure(Path("projects/code_project"))
if result.is_valid:
    print("Project structure is valid")
else:
    print(f"Issues: {result.issues}")

Extract Project Metadata

from pathlib import Path
from infrastructure.project import get_project_metadata

metadata = get_project_metadata(Path("projects/code_project"))
print(f"Title: {metadata.title}")
print(f"Authors: {metadata.authors}")

Discovery Rules

A directory is a valid project if and only if:

  1. It exists as a subdirectory of projects/
  2. It contains manuscript/config.yaml
  3. It does not start with _ or .

Projects in projects_in_progress/ and projects_archive/ are not discovered.

Public API

Symbol Type Purpose
ProjectInfo Dataclass Project metadata container
discover_projects Function Find all valid projects
get_project_metadata Function Extract config.yaml metadata
validate_project_structure Function Verify directory structure

Related Documentation