oct Documentation

Contents:

• OCT — Option C Tools
  • Table of Contents
  • Installation
  • Quick Start
  • Project Structure Requirements
  • Global Options
  • Commands Reference
  • Option C Compliance Rules
  • oc_diagnostics Integration
  • Workflows
  • Architecture Notes
  • Configuration
  • Reference
• OCT Architecture Document
• 1. Overview
• 2. High-Level Architecture
• 3. Directory Structure of OCT
  • 3.1 Module Dependency Graph
• 4. OCT CLI
  • Available Commands
  • CLI Design Patterns
• 5. OCT Modules
  • 5.1 Core (oct/core/)
  • 5.2 Linter (oct/linter/oct_lint.py)
  • 5.3 Formatter (oct/formatter/oct_format.py)
  • 5.4 Health Dashboard (oct/health/oct_health.py)
  • 5.5 File Generator (oct/generator/new_python_file.py)
  • 5.6 Source Exporter (oct/tools/source_exporter.py)
  • 5.7 Documentation Pipelines (oct/docs/oct_docs.py)
  • 5.8 Skeleton Exporter (oct/tools/skeleton_exporter.py)
  • 5.9 Git Integration (oct/git/)
• 6. Configuration
  • 6.1 Per-project linter configuration (.octrc.json)
  • 6.2 Secret scanner configuration (secret_scanner in .octrc.json)
  • 6.3 Per-project exporter configuration (_oct_exporter_config.json)
• 7. oc_diagnostics Integration
  • Project structure
  • Installation
  • Import surface
  • debug_config.json — full schema
  • OCT Integration
• 8. Option C Coding Rules (Summary)
  • 8.1 File headers
  • 8.2 Module docstrings
  • 8.3 Diagnostics
  • 8.4 Trivial file exemption
  • 8.5 Testing
  • 8.6 Architecture
• 9. Test Suite
• 10. OCT Project Lifecycle
• 11. Future Enhancements
• 12. Appendix: Example OCT-Generated File
• OCT Reference
  • Table of Contents
  • 1. Installation & Entry Point
  • 2. Project Root Detection
  • 3. CLI Commands — Complete Reference
  • 4. Configuration
  • 5. Option C Compliance Rules
  • 6. Linter Internals
  • 7. Formatter Internals
  • 8. Generator Internals
  • 9. Health Dashboard Internals
  • 10. Diagnostics Config Tools Internals
  • 11. Source Exporter Internals
  • 12. oc_diagnostics Integration Points
• OCT Ecosystem Roadmap (Curated & Prioritized)
  • Phase 1 — Diagnostics System Extraction ✅ COMPLETED — oc_diagnostics v1.5
  • Phase 2 — OCT Scaffolding & Project Templates
  • Phase 3 — OCT Documentation Tools ✅ SUBSTANTIALLY COMPLETE
  • Phase 4 — OCT Linter Enhancements
  • Phase 5 — OCT CLI Expansion
  • Phase 6 — Source Exporter Enhancements
  • Phase 7 — Ecosystem Documentation
  • Phase 8 — Linter Packaging (Optional)
  • Summary of Priorities
• Option C Linter
  • Purpose
  • Mandatory Header Block
• -- coding: utf-8 --
• <project_name>/<relative/path/to/file.py>
  • func = "..." Pattern Check
  • no_hardcoded_secrets Check (§6b Secret Hygiene)
  • Usage
  • Test Suite
  • Continuous Integration
  • Project Philosophy
  • License

API Reference:

• API Reference
  • oct package
    • Subpackages
    • Submodules