project-big-data 0.1.0

ToDo list du projet kit big data

To-Do List Python Library

Overview

This project aims to create a comprehensive Python library for managing personal tasks (To-Do List).

Features

The application allows users to:

• Add a new task to the list with at least a name and a description.
• Mark a task as completed.
• Remove a task from the list.
• Display the list of ongoing tasks.

Getting Started

These instructions will get the project up and running on your local machine for development and testing purposes.

Prerequisites

• Python 3.x
• Poetry

Installation

Using Docker

1. Clone the repository:

   git clone https://github.com/Nhurbis/projet_kit_big_data.git
   cd projet_kit_big_data
   

2. Build and run the Docker container:

   docker build -t les_meures .
   docker run -it -p 7860:7860 les_meures
   

3. Access the application in your web browser at: http://0.0.0.0:7860/

Using Poetry

1. Clone the repository:

   git clone https://github.com/Nhurbis/projet_kit_big_data.git
   cd projet_kit_big_data
   

2. Set up a virtual environment and install dependencies:

   poetry install
   

Task Manager CLI

The Task Manager CLI is a command-line tool for managing your tasks and task lists. Here is a guide on how to use it.

Installation

Ensure you have installed all the necessary dependencies and configured your Python environment correctly before running the application.

Commands

python task_manager_cli.py create_tasklist <title>
python task_manager_cli.py add_task <tasklist_id> <name> <description>
python task_manager_cli.py complete_task <tasklist_id> <task_id>
python task_manager_cli.py delete_task <tasklist_id> <task_id>
python task_manager_cli.py show_incomplete_tasks <tasklist_id>

Example Usage:

python task_manager_cli.py create_tasklist "My Task List"
python task_manager_cli.py add_task 1 "Go Shopping" "Buy milk, eggs, and bread"
python task_manager_cli.py complete_task 1 1
python task_manager_cli.py show_incomplete_tasks 1

Testing

We use pytest for unit testing. Run the tests using the following command:

pytest --cov=model tests/

Documentation

The documentation for this project is generated using Sphinx. To build the documentation locally, run the following commands in the docs folder:

make html

Then, open docs/_build/html/index.html in a web browser.

CI/CD

This project is set up with a CI/CD pipeline using GitHub Actions. Any push to the main branch triggers the pipeline, which runs tests, checks code coverage, and deploys the documentation.

Sécurité

As part of this project, and in order to facilitate the teacher's grading process, the decision was made to leave the database connection string visible in the code (instead of using environment variables). Additionally, we are directly returning the _id values to facilitate the use of the very simplistic gradio interface. In a real production environment, these choices would not have been made.