todolist_lb_me_ab 1.0.0

No project description provided

KitBigData_Todolist

Projet Kit big data

L'objectif de ce projet est de mettre en pratique les concepts et les compétences appris en cours sur le développement Python pour la production et créer une bibliothèque Python complète de tâches personnelles (To-Do List). Le but étant de couvrir un certain nombre d'étapes clef, notamment: la structure du projet, la gestion de l'environnement Python avec Poetry, la programmation orientée objet, le type hinting, la gestion des logs, le respect des normes PEP 8, la gestion des exceptions, la sécurité, les tests unitaires avec pytest, le test coverage, la documentation avec Sphinx, et la mise en place d'un pipeline CI/CD avec GitHub Actions.

Installation guide

install dependencies

• pip install poetry
• apt-install pandoc

Installation

• poetry install

User manual

• The TODOLIST consist of a class where the interface is callbable over the api todolist_lb_me_ab.
• There are 5 methods to manipulate a todolist_lb_me_ab
• Each task has several attributes : --nom, --description, --status, --projet, --horodatage

Usage example : (from todolist_lb_me_ab directory)

• Add a new task to the list : todolist_lb_me_ab -a --nom "<nom>" --description "<description>"
• Modify an existing task : todolist_lb_me_ab -m --nom "<nom>" --<attribute to change> ...
• Delete an existing task : todolist_lb_me_ab -d --nom "<nom>"
• Get the list of tasks : todolist_lb_me_ab -l
• Terminate an existing task: todolist_lb_me_ab -t --nom "<nom>"

Developper manual

Testing

• python3 -m unittest tests/test_tache.py
• python3 -m unittest tests/test_todolist_lb_me_ab.py

Coverage

• poetry run python -m coverage run -m unittest tests/test_tache.py
• poetry run python -m coverage run -a -m unittest tests/test_todolist.py
• poetry run python -m coverage report

Documentation Sphinx

• Generate the doc (all .rst are update automaticaly through 'conf.py') poetry run make -C docs html
• Access the doc : search for 'index.html' in '.docs/html'