- .. image:: https://img.shields.io/travis/physumasso/auxiclean.svg?maxAge=600?branch=master
target: https://travis-ci.org/physumasso/auxiclean
Ce projet est une initiative des étudiants et étudiantes au département de physique de l'Université de Montréal afin de créer une approche automatisée pour l'attribution des tâches d'assistanat d'enseignement.
Le code source initial a été écrit par Jérémie Tanguay (Tanjay94 sur GitHub).
Pour installer le projet, il faut un interpréteur python 3. Un bon example est Miniconda produit par Continuum Analytics.
Ensuite, cloner ou télécharger le projet sur le répertoire officiel du projet sur GitHub et décompresser le fichier si nécéssaire.
Pour installer le module, il faut executer le script d'installation setup.py:
$ python setup.py install
Pour une installation de développement, utiliser l'argument develop au lieu de install car d'autres dépendances sont nécéssaires afin de faire rouler les tests.
Le code fonctionne en lui donnant deux fichiers Excel: un contenant les données de toutes les candidatures et l'autre contenant les détails sur les cours à attribuer.
Pour contribuer au projet, simplement faire un fork du projet sur GitHub et soumettre des pull request ou bien contacter un des responsable du projet via la PHYSUM.
Pour les développeurs, il y a des unittests qui sont écrits afin d'aider le développement et pour vérifier que tout marche encore. Ces tests sont exécutés par le CI runner Travis pour tous les Pull Requests. Pour les exécuter sur une machine locale, s'assurer d'avoir installer le module en mode 'develop':
$ python setup.py develop
Et pour exécuter les tests, il suffit d'exécuter le script tests.py:
$ python tests.py
La liste de tous les contributeurs au code:
- Jérémie Tanguay (Tanjay94)
- Félix Antoine Goudreault (fgoudreault)