Filesystem Organization¶

This document describes the specific filesystem organization for the project, showing how the standard organizational patterns are implemented for this project’s configuration. For the underlying principles and rationale behind these patterns, see the common architecture documentation.

Project Structure¶

Root Directory Organization¶

The project implements the standard filesystem organization:

python-detextive/
├── LICENSE.txt              # Project license
├── README.rst               # Project overview and quick start
├── pyproject.toml           # Python packaging and tool configuration
├── documentation/           # Sphinx documentation source
├── sources/                 # All source code
├── tests/                   # Test suites
└── .auxiliary/              # Development workspace

Source Code Organization¶

Package Structure¶

The main Python package follows the standard sources/ directory pattern:

sources/
├── detextive/          # Main Python package
│   ├── __/                      # Centralized import hub
│   │   ├── __init__.py          # Re-exports core utilities
│   │   ├── imports.py           # External library imports and ddoc alias
│   │   └── nomina.py            # python-detextive-specific naming constants
│   ├── __init__.py              # Package entry point
│   ├── py.typed                 # Type checking marker
│   ├── detection.py             # Core detection function implementations
│   ├── exceptions.py            # Package exception hierarchy
│   └── lineseparators.py        # LineSeparators enum and utilities

All package modules use the standard __ import pattern as documented in the common architecture guide.

Component Integration¶

Exception Organization¶

Package-wide exceptions are centralized in sources/detextive/exceptions.py following the standard hierarchy patterns documented in the common practices guide.

Architecture Evolution¶

This filesystem organization provides a foundation that architect agents can evolve as the project grows. For questions about organizational principles, subpackage patterns, or testing strategies, refer to the comprehensive common documentation: