https://github.com/syntaxarc/archipy
Architecture + Python – perfect for structured design.
https://github.com/syntaxarc/archipy
fastapi pydantic python
Last synced: about 2 months ago
JSON representation
Architecture + Python – perfect for structured design.
- Host: GitHub
- URL: https://github.com/syntaxarc/archipy
- Owner: SyntaxArc
- License: apache-2.0
- Created: 2025-02-16T09:45:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-04-27T10:14:03.000Z (about 2 months ago)
- Last Synced: 2026-04-27T10:23:46.121Z (about 2 months ago)
- Topics: fastapi, pydantic, python
- Language: Python
- Homepage: https://archipy.readthedocs.io/
- Size: 48.7 MB
- Stars: 37
- Watchers: 0
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# ArchiPy - Architecture + Python
[](https://github.com/SyntaxArc/ArchiPy/network/members)
[](https://github.com/SyntaxArc/ArchiPy/stargazers)
[](https://www.python.org/downloads/)
[](https://docs.astral.sh/uv/)
[](https://syntaxarc.github.io/ArchiPy/)
[](https://github.com/SyntaxArc/ArchiPy/blob/master/LICENSE)
[](https://github.com/SyntaxArc/ArchiPy)
[](https://github.com/SyntaxArc/ArchiPy/blob/master/CONTRIBUTING.md)
[](https://pypi.org/project/archipy/)
[](https://pypi.org/project/archipy/)
[](https://github.com/SyntaxArc/ArchiPy/graphs/contributors)
[](https://github.com/SyntaxArc/ArchiPy/commits/main)
[](https://github.com/SyntaxArc/ArchiPy/issues)
[](https://github.com/SyntaxArc/ArchiPy/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/SyntaxArc/ArchiPy/pulls)
[](https://github.com/SyntaxArc/ArchiPy)
[](https://github.com/SyntaxArc/ArchiPy)
## **Structured Python Development Made Simple**
ArchiPy is a Python framework designed to provide a standardized, scalable, and maintainable architecture for modern applications. Built with Python 3.14+, it offers a suite of tools, utilities, and best practices to streamline configuration management, testing, and development workflows while adhering to clean architecture principles.
---
## 📋 Table of Contents
- [ArchiPy - Architecture + Python](#archipy---architecture--python)
- [**Structured Python Development Made Simple**](#structured-python-development-made-simple)
- [📋 Table of Contents](#-table-of-contents)
- [🎯 Goals](#-goals)
- [✨ Features](#-features)
- [🛠️ Prerequisites](#️-prerequisites)
- [📥 Installation](#-installation)
- [🎯 Usage](#-usage)
- [Optional Dependencies](#optional-dependencies)
- [🛠️ Development](#️-development)
- [Quick Commands](#quick-commands)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
- [🙌 Sponsors](#-sponsors)
- [📞 Contact](#-contact)
- [🔗 Links](#-links)
- [📚 Documentation](#-documentation)
- [Quick Start](#quick-start)
---
## 🎯 Goals
ArchiPy is built with the following objectives in mind:
1. **Configuration Management & Injection** - Simplify and standardize configuration handling
2. **Common Adapters & Mocks** - Provide ready-to-use adapters with testing mocks
3. **Standardized Entities & DTOs** - Enforce consistency in data modeling
4. **Common Helpers for Everyday Tasks** - Simplify routine development work
5. **Behavior-Driven Development (BDD) Support** - Enable robust feature validation
6. **Best Practices & Development Structure** - Enforce coding standards
[Read more about ArchiPy's architecture and design](https://syntaxarc.github.io/ArchiPy/architecture)
---
## ✨ Features
- **Config Standardization**: Tools for managing and injecting configurations
- **Adapters & Mocks**: Pre-built adapters for Redis, SQLAlchemy, and email with testing mocks
- **Data Standardization**: Base entities, DTOs, and type safety
- **Helper Utilities**: Reusable tools for common tasks
- **BDD Testing**: Fully integrated Behave setup
- **Modern Tooling**: Dependency management and code quality tools
[Explore the complete feature set](https://syntaxarc.github.io/ArchiPy/features)
---
## 🛠️ Prerequisites
- **Python 3.14 or higher**
- **UV** (recommended for development)
---
## 📥 Installation
Install using pip
```bash
# Basic installation
pip install archipy
# With optional dependencies (e.g., Redis and FastAPI)
pip install archipy[redis,fastapi]
```
Using UV:
```bash
uv add archipy
# With optional dependencies
uv add archipy[redis,fastapi]
```
[View installation documentation](https://syntaxarc.github.io/ArchiPy/installation)
---
## 🎯 Usage
### Optional Dependencies
ArchiPy's modular design lets you install only what you need:
```bash
# Examples
pip install archipy[redis] # Redis support
pip install archipy[fastapi] # FastAPI framework
pip install archipy[postgres] # PostgreSQL support
```
[See the documentation for all available options and examples](https://syntaxarc.github.io/ArchiPy/usage)
---
## 🛠️ Development
### Quick Commands
```bash
# Format code
make format
# Run tests
make behave
# Lint code
make lint
```
[View the complete development guide](https://syntaxarc.github.io/ArchiPy/development)
---
## 🤝 Contributing
Contributions are welcome! See our [contribution guidelines](CONTRIBUTING.md) for details.
---
## 📄 License
This project is licensed under the terms of the [LICENSE](LICENSE) file.
---
## 🙌 Sponsors
Support ArchiPy by checking out our amazing sponsors! [View Sponsors](SPONSORS.md)
---
## 📞 Contact
- **Mehdi Einali**: [einali@gmail.com](mailto:einali@gmail.com)
- **Hossein Nejati**: [hosseinnejati14@gmail.com](mailto:hosseinnejati14@gmail.com)
---
## 🔗 Links
- [Documentation](https://syntaxarc.github.io/ArchiPy/)
- [GitHub Repository](https://github.com/SyntaxArc/ArchiPy)
- [PyPI Package](https://pypi.org/project/archipy/)
## 📚 Documentation
ArchiPy's documentation has been migrated from Sphinx to MkDocs for improved readability and organization:
- **Modern Interface**: Material theme with responsive design
- **Improved Navigation**: Intuitive organization and search
- **Clearer Examples**: Expanded code samples with explanations
- **API Reference**: Auto-generated from source code docstrings
- **Performance Optimized**: Multiple build modes for fast iteration
### Quick Start
```bash
# Install documentation dependencies
uv sync --group docs
# Fast mode for quick iterations (10-20s builds)
make docs-serve-fast
# Balanced mode for regular work (30-60s builds)
make docs-serve
# Full production build (2-5min, all features)
make docs-build-full
# Deploy to GitHub Pages
make docs-deploy
```
**See [DOCS_QUICKSTART.md](DOCS_QUICKSTART.md) for more commands and tips.**
[View the latest documentation](https://syntaxarc.github.io/ArchiPy/)