Deply Documentation

Welcome to the Deply documentation! This documentation will help you understand and use Deply effectively.

Table of Contents

1. Getting Started
   • Installation
   • Basic Usage
   • Configuration
2. Features
   • Layer-Based Analysis
   • Dynamic Layer Configuration
   • Cross-Layer Dependency Rules
   • Extensibility
3. Configuration Guide
   • Configuration File Structure
   • Layer Definitions
   • Rules and Collectors
   • Examples
4. Collectors Reference
   • BoolCollector
   • ClassInheritsCollector
   • ClassNameRegexCollector
   • FunctionNameRegexCollector
5. Rules
   • Rule Types
   • Rule Configuration
   • Common Patterns
   • Best Practices
6. Mermaid Diagrams
   • Generating Diagrams
   • Diagram Elements
   • Example Diagrams
   • Best Practices
7. Command Line Interface
   • Available Commands
   • Command Line Arguments
   • Output Formats
   • Examples

About Deply

Deply is a standalone Python tool for enforcing architectural patterns and dependencies in large Python projects. By analyzing code structure and dependencies, this tool ensures that architectural rules are followed, promoting cleaner, more maintainable, and modular codebases.