Commit 3b91c40d authored by matograine's avatar matograine

* modify the README

parent a5dc8b2a
# Présentation
G1pourboire est un outil permettant de générer des pourboires en Ğ1.
En développement, ceci est une version Alpha.
En phase de développement, ceci est une version Alpha.
Il est fonctionnel en ligne de commande, mais pas (encore ?) en interface graphique. Cette contribution est bienvenue !
# Installation
Le logiciel n'est pas encore packagé, vous devez l'installer à la main.
Le logiciel est empaqueté et référencé avec Pypi-test pour le moment.
## Installation des dépendances DEBIAN
- `python3`
- `pip3`
- `git`
Nous avons rencontré des soucis sur ces dépendances :
- `tkinter` -> installer le paquet python3-tk (sur Debian Buster)
### Debian :
```
$ sudo apt-get install python3 python3-pip git python3-qrcode python3-reportlab python3-pil ; sudo python3.5 -m pip install duniterpy
$ sudo apt-get install python3 python3-pip
$ python3 -m pip install --index-url https://test.pypi.org/simple/ gdon # à tester
```
## Installation de G1pourboire
## Installation pour les devs :
Désolé, le dépôt est encore nommé "Ğ1pourboire", ancien nom du projet
```
$ git clone https://git.duniter.org/Darks/g1pourboire.git
# apt install pipenv
$ git clone https://git.duniter.org/matograine/g1pourboire.git
$ cd g1pourboire
$ pip3 install -r requirements.txt
$ pipenv install '-e .'
$ pipenv run gdon
```
# Utilisation
Actuellement le logiciel se lance en ligne de commande :
Générer des dons : "generer <montant> <nombre_pages> <peremption_date_JJ/MM/AAAA>"
Récupérer des dons : "recuperer"
Récupérer des dons depuis un dossier : "recuperer <dossier>"
Récupérer des dons depuis un fichier : "recuperer fichier <fichier>"
En cas de mauvaise récupération, tenter une récupération des backups : "recuperer backup <année>"
La récupération des backups est possible à plusieurs reprises.
Configurer le noeud Duniter : "noeud <noeud> <port>"
Les Ğ1Dons sont enregistrés dans ~/Documents/G1pourboire/.
Les fichiers de récupération sont enregistrés dans ~/Documents/G1pourboire/Recuperation_ne_pas_supprimer/.
Lors d'une récupération, les fichiers récupérés sont enregistrés dans ~/Documents/G1pourboire/.backup/<année> en cas de transaction mal effectuée.
* Générer et remplir des Ğ1Dons :
Les Ğ1Dons seront bloqués jusqu'à la péremption.
Le compte depuis lequel vous crééez les Ğ1Dons vous sera nécessaire pour les récupérer.
```
$ gdon generer <montant> <nombre_pages> <peremption_date_JJ/MM/AAAA>
```
* Récupérer le contenu de Ğ1Dons :
```
$ gdon recuperer
```
* Pour générer et remplir des Ğ1Pourboires :
* Récupérer des Ğ1Dons depuis un dossier de sauvegarde:
```
gdon recuperer<dossier>
```
* Récupérer des Ğ1Dons depuis un fichier:
```
$ ./main.py generate <amount> <pages_number> <peremption_date>
recuperer fichier <fichier>
```
* Pour récupérer le contenu de Ğ1Pourboires :
* Si la récupération s'est mal passée :
```
$ ./main.py retrieve <path/to/file> <your_pubkey>
recuperer backup <année>
```
Les pourboires générés sont stockés dans `~/Documents/G1pourboire/`. Deux fichiers sont créés :
* Configurer le noeud Duniter :
```
gdon noeud <noeud> <port>
```
- PDF : fichier à imprimer puis découper
- Json : sauvegarde des identifiants de comptes
Les dons générés sont stockés dans `~/Documents/G1dons/` en pdf.
Les fichiers de récupération sont dans ~/Documents/G1dons/Récupération. Ne pas le supprimer !
**Attention !** Actuellement, les fichiers de sortie ont pour nom la date et l'heure courante, à la minute près. Il n'y a pas de vérification si un fichier du même nom existe. Cela veut dire qu'une seconde génération dans la même minute écrasera la génération précédente.
# TODO
- Inteface graphique
- Provisionnement automatique
- Interface graphique
- Suivi des pourboires générés
X Récupération du solde des pourboires expirés
- Paquet stand-alone pour Windows
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment