0155-python-project-structure

What problem does it solve?

It solves the problem of messy, hard-to-navigate Python codebases by guiding you to design a maintainable project structure with clear module boundaries and well-defined public interfaces.

Core Features & Use Cases

• Module architecture and cohesion: Organize related code so each module has a single purpose and predictable change patterns.
• Explicit public interfaces: Use __all__ in __init__.py to clearly expose what belongs to your public API while keeping internals private.
• Practical directory layout guidance: Choose flat vs nested hierarchies, align file names with content, and plan package initialization for clean imports.
• Testing strategy options: Decide between colocated tests and a parallel tests/ directory and apply the chosen pattern consistently.
• Layered and domain-driven structure templates: Implement separation of concerns by architectural layer or organize by business domain for larger systems.
• Use cases: Starting a new project, reorganizing for clarity, defining library entry points for consumers, and planning a directory layout before implementation.

Quick Start

Use the skill to plan your new Python project's src/ package layout, choose where tests live, and define each module’s public API using explicit __all__ exports.