Awesome-Python-Scripts/Work_Log_Generator/README.rst
2018-10-04 19:31:58 +02:00

47 lines
1.6 KiB
ReStructuredText

`Work log generator`
--------------------
📝 C'est quoi?
===============
Ce simple script python permet de générer un journal de travail au format rst à partir des commits de l'un de vos dépôts.
🔘 Comment l'utiliser?
=======================
Il est nécessaire de commencer par générer un jeton d'accès et de l'entrer dans le premier champ de la fenêtre.
Pour le générer, rendez-vous `ici`_ dans la section "Personal access tokens".
À présent, il est possible de presser sur le bouton de connexion. Dès lors, une liste déroulante affiche les dépôts disponibles.
Après le choix du dépôt, le dernier bouton permet d'ouvrir le log, de le modifier et de le sauvegarder au format rst.
Il est maintenant possible de le convertir en utilisant pandoc ou n'importe quelle autre convertisseur que vous préférez.
Enjoy!
📝 What is this?
================
This simple python script allows you to generate a worklog in rst format based on your repo commits.
🔘 How to use it?
=================
Simply generate a personnal access token and enter it in the first field of the window.
In order to generate this token, go `here`_ under "Personal access tokens".
Then, it is possible to press on the connection button. Since then a dropdown list display the available repositories.
After choosing the repository, the last button allows you to open the log, edit it and save it in rst format.
You can then convert it using pandoc or any other converter you prefer.
Enjoy!
.. _`ici`: https://github.com/settings/tokens
.. _`here`: https://github.com/settings/tokens