Skip to content

AnaelTech/ToDoList

Repository files navigation

ToDoList API

ToDoList est une application API construite avec FastAPI, permettant de gérer une liste de tâches. Ce projet utilise des méthodes DevOps et est déployable avec Docker.

Fonctionnalités

  • Ajouter des tâches.
  • Consulter toutes les tâches.
  • Modifier une tâche.
  • Supprimer une tâche.

Prérequis

Avant de commencer, assurez-vous d'avoir les éléments suivants installés sur votre machine :

Installation

1. Clonez le dépôt

git clone https://github.com/AnaelTech/ToDoList.git
cd ToDoList

2. Installez les dépendances (optionnel si vous utilisez Docker uniquement)

Créez un environnement virtuel et installez les dépendances :

python -m venv venv
source venv/bin/activate  # Sur Windows : venv\Scripts\activate
pip install -r requirements.txt

3. Configuration de l'application

Si votre application nécessite des variables d'environnement (par exemple pour la base de données), créez un fichier .env à la racine du projet et configurez vos variables :

DATABASE_URL=sqlite:///./todolist.db

4. Lancer avec Docker

Construisez et lancez le conteneur Docker :

docker build -t todolist-api .
docker run -d -p 8000:8000 todolist-api

L'API sera disponible à l'adresse : http://localhost:8000.

Utilisation

Documentation de l'API

FastAPI gère automatiquement une documentation interactive que vous pouvez consulter à :

Points d'entrée principaux

Voici un résumé des principales routes disponibles :

Méthode Endpoint Description
GET /tasks Récupère toutes les tâches
POST /tasks Crée une nouvelle tâche
GET /tasks/{id} Récupère une tâche par ID
PUT /tasks/{id} Modifie une tâche
DELETE /tasks/{id} Supprime une tâche

Tests

Pour exécuter les tests unitaires (si disponibles) :

pytest

Développé par AnaelTech.

About

Création d'une todo avec python et utilisation de pratique DevOps 🐍

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •