API Reference¶

Welcome to the ArchiPy API reference documentation. This section provides detailed information about all modules, classes, and functions in ArchiPy.

Core Modules¶

Adapters¶

The adapters module provides standardized interfaces to external systems:

Configs¶

Configuration management and injection tools:

Configs Documentation

Helpers¶

Utility functions and support classes:

Models¶

Core data structures and types:

Source Code Organization¶

The ArchiPy source code is organized into the following structure:

archipy/
├── adapters/           # External system integrations
│   ├── base/          # Base SQLAlchemy components
│   ├── elasticsearch/ # Elasticsearch adapter
│   ├── email/         # Email service adapter
│   ├── internet_payment_gateways/ # Payment gateway adapters
│   ├── kafka/         # Kafka message streaming adapter
│   ├── keycloak/      # Keycloak authentication adapter
│   ├── minio/         # MinIO object storage adapter
│   ├── postgres/      # PostgreSQL adapter
│   ├── redis/         # Redis adapter
│   ├── scylladb/      # ScyllaDB/Cassandra adapter
│   ├── sqlite/        # SQLite adapter
│   ├── starrocks/     # StarRocks adapter
│   └── temporal/      # Temporal workflow adapter
├── configs/           # Configuration management
│   ├── base_config.py
│   ├── config_template.py
│   └── environment_type.py
├── helpers/           # Utility functions and patterns
│   ├── decorators/
│   ├── interceptors/
│   ├── metaclasses/
│   └── utils/
└── models/            # Core data structures
    ├── dtos/
    ├── entities/
    ├── errors/
    └── types/

API Stability¶

ArchiPy follows semantic versioning and marks API stability as follows:

🟢 Stable: Production-ready APIs, covered by semantic versioning
🟡 Beta: APIs that are stabilizing but may have breaking changes
🔴 Alpha: Experimental APIs that may change significantly

See the Changelog for version history and breaking changes.

Contributing¶

For information about contributing to ArchiPy's development, please see: