flask-boilerplate

Description

Ce modèle de base est un point de départ solide pour créer des applications Flask prêtes à la production. Bien que conçu pour Flask, ses principes de base sont suffisamment polyvalents pour s'appliquer à d'autres frameworks et langages. Il s'agit notamment de maintenir une architecture propre, de mettre en œuvre une conception axée sur le domaine (DDD) et d'adhérer aux principes SOLID pour la conception orientée objet. Le projet intègre également les modèles CQRS (Command Query Responsibility Segregation) et DTO (Data Transfer Object), qui améliorent la gestion des données et la clarté du système. En adoptant le développement piloté par les tests (TDD), le boilerplate garantit un code fiable et de haute qualité. En appliquant ces meilleures pratiques, les développeurs peuvent créer des applications évolutives et faciles à maintenir, conformes aux normes modernes d'ingénierie logicielle.

Badges

Statut du projet

Langages utilisés

Qualité du code

Securité

Documentation

Contributions

⚡ Caractéristiques

• Gestion des dépendances et des paquets : Poetry
• Hooks: Pre-commit
• Framework: Flask
• ORM: SQLAlchemy
• Format et Style: Ruff + MyPy
• Tests: Pytest
• Securité: Snyk + Bandit
• Documentation: Sphinx

👉 Table des matières

• Pour commencer
• Principes
• Workflow Git Flow
• Structure des répertoires et Organisation du code
• Ressources utiles
• Génération de types de clients

✨ Pour commencer

```bash git clone https://github.com/cedric57/flask-boilerplate.git my-app cd my-app

Pour activer poetry, suivez les instructions ici : https://python-poetry.org/docs/#installing-with-the-official-installer

poetry install #Installer les dépendances. ```

Commandes courantes

• poetry install - Installation avec poetry
• poetry install --extras "web cli" - Installation avec extras
• poetry install --with dev - Installation pour développement
• poetry install --with docs - Installation pour documentation
• poetry run pytest - Lancer les tests
• poetry run black . - Formatter le code
• poetry run isort . - Formatter le code
• poetry run mypy . - Vérifier les types
• poetry run flask-boilerplate - Lancer l'application
• poetry add requests - Ajout d'une dépendance
• poetry add --group dev pytest - Ajout d'une dépendance de dev

🧱 Principes

🛠 Workflow Git Flow

📁 Structure des répertoires et Organisation du code <!-- {#structure-des-repertoires-et-organisation-du-code} -->

Ressources utiles

Génération de types de clients <!-- {#generation-de-types-de-clients} -->

Contribuer

Les contributions sont toujours les bienvenues ! Si vous avez des idées, des suggestions, des corrections, n'hésitez pas à contribuer. Vous pouvez le faire en suivant les étapes suivantes :

1. Cloner ce repo
2. Créer une branche : git checkout -b votre-fonctionnalité
3. Faites quelques changements
4. Testez vos changements
5. Poussez votre branche et ouvrez une Pull Request

Licence

MIT