Metadata-Version: 2.4
Name: elrahapi
Version: 1.2.2
Summary: Biliothèque personnalisée pour accéler le devéloppement d'API basé sur FastAPI.
Project-URL: Repository, https://github.com/Harlequelrah/Library-ElrahAPI
Project-URL: Documentation, https://harlequelrah.github.io/Library-ElrahAPI/docs/documentation
Project-URL: Guide, https://harlequelrah.github.io/Library-ElrahAPI/docs/guide
Author-email: Harlequelrah <maximeatsoudegbovi@gmail.com>
License-Expression: LGPL-3.0-only
Requires-Python: >=3.14
Requires-Dist: aiosqlite>=0.21.0
Requires-Dist: alembic>=1.13.3
Requires-Dist: argon2-cffi>=23.1.0
Requires-Dist: black>=24.10.0
Requires-Dist: fastapi[standard]>=0.128.0
Requires-Dist: python-jose[cryptography]>=3.3.0
Requires-Dist: sqlalchemy-utils>=0.41.2
Requires-Dist: sqlalchemy>=2.0.38
Description-Content-Type: text/markdown

# I - **`Présentation`**

![Logo](Elrah.png)

# **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)
