https://github.com/harlequelrah/library-elrahapi
Package de développement d'API basé sur FASTAPI , pour automatiser des configurations , et accélérer de développement d'API .
https://github.com/harlequelrah/library-elrahapi
api fastapi package python
Last synced: 3 months ago
JSON representation
Package de développement d'API basé sur FASTAPI , pour automatiser des configurations , et accélérer de développement d'API .
- Host: GitHub
- URL: https://github.com/harlequelrah/library-elrahapi
- Owner: Harlequelrah
- Created: 2024-10-25T19:11:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-19T00:56:35.000Z (7 months ago)
- Last Synced: 2025-11-19T01:22:09.123Z (7 months ago)
- Topics: api, fastapi, package, python
- Language: Python
- Homepage:
- Size: 806 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# I - **`Présentation`**
# **1.** `Description`
Passioné par la programmation et le développement avec python je me lance dans la création progressive d'une bibliothèque personnalisée basé sur pour `FASTAPI` m'ameliorer , devenir plus productif et partager mon expertise .
# **2.** `Objectifs`
ElrahAPI permet notament dans le cadre d'un développement avec FASTAPI de :
- Démarrer rapidement un projet en fournissant une architecture de dossier ;
- Minimiser les configurations de base de données et de gestion des sessions pour un projet ;
- Fournir et gérer un système d'authentification simple et configurable ;
- Générer les principaux cruds d'un model ;
- Fournir Configurer facilement les routes avec des configurations personnalisées ;
- Pemettre d'utiliser les sessions asynchrones ;
- Fourni des classes pour gérer les seeders ;
- Permet d'effectuer un enregistrement des logs dans la base de donnée grâce à un middleware de log ;
- Fournir un middleware de gestion d'erreur ;
- Une gestion simple et efficace de l'autorisation par l'utilisation de rôles et privileges ;
- Fournir une pile d'utilitaires ;
- L'utilisation de gestionnaire de websocket .
# II - **`Installation`**
**Il serait judicieux de créer un environnement virtuel dans un repertoire avant de poursuivre l'installation**
- **Créer un environnement virtuel :**
```bash
python -m venv env
```
ou si virtualenv est dejà installé au préalable
```bash
virtualenv env
```
- **`Avec Github :`**
```bash
git clone https://github.com/Harlequelrah/Library-ElrahAPI
cd Library-ElrahAPI
pip install -e ./elrahapi
```
- **`Avec pip :`**
```bash
pip install elrahapi
```
# III - **`Contact ou Support`**
Pour des questions ou du support, contactez-moi à **`maximeatsoudegbovi@gmail.com`** ou au **`(+228) 91 36 10 29`**.
La version actuelle est le `1.2.2`
Vérifier la version en executant `pip show elrahapi`
Pour un exemple concret , vous pouvez consulter la branche du repository de test pour cette version ou la plus récente si les améliorations son minimes: `https://github.com/Harlequelrah/elrahapi-testproject`
`La documentation` et `le guide d'utilisation` se trouvent dans le repertoire docs :
```
docs/
├── documentation.md
├── guide.md
```
Les liens ci-dessous permettent d'accéder à une documentation web :
- [Documentation](https//elrahapi.elrah.tech/docs/documentation)
- [Guide d'utilisation](https://elrahapi.elrah.tech/docs/guide)