Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avivace/french-attestation-generator
A bot to generate Attestation de déplacement dérogatoire documents on the go, just by sending a telegram message.
https://github.com/avivace/french-attestation-generator
attestation-deplacement covid-attestation telegram-bot
Last synced: 13 days ago
JSON representation
A bot to generate Attestation de déplacement dérogatoire documents on the go, just by sending a telegram message.
- Host: GitHub
- URL: https://github.com/avivace/french-attestation-generator
- Owner: avivace
- License: mit
- Created: 2020-11-13T17:31:04.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-18T10:15:44.000Z (about 4 years ago)
- Last Synced: 2024-11-03T17:02:39.566Z (2 months ago)
- Topics: attestation-deplacement, covid-attestation, telegram-bot
- Language: JavaScript
- Homepage:
- Size: 74.2 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## *Attestation de déplacement dérogatoire* telegram bot
A bot to generate Attestation de déplacement dérogatoire documents on the go, just by sending a telegram message.
### DISCLAIMER
**This is an unofficial tool. Therefore, there is not guarantee that the generated PDF are correct or to be trusted. Always check the generated PDF for errors before going out. We take no responsibility for any errors in the PDFs. Using this software you acknoweledge that we waive any responsbility on the correctess of the generated certifications. USE THIS AT YOUR OWN RISK.**
**Work In Progress Notice**: the bot UX is still raw and unforgiving. It expects a well formatted JSON stringified object and will break on syntax errors or missing keys.
A public instance of the bot should be available at [@giovanniFaGenBot](https://t.me/giovanniFaGenBot) but self-hosting your own instance is quick and easy:
### Telegram Bot
Install dependencies and run the Telegram bot:
```bash
npm install
BOT_TOKEN=YOUR_BOT_TOKEN_HERE node bot.js
```
You can get a bot token talking with @BotFather on Telegram.
Open the conversation with the bot and send a JSON string in this form:
```javascript
{
"firstname": "Antuzzo",
"lastname": "surname",
"birthday": "01/01/1991",
"placeofbirth": "Wien, Autriche",
"address": "16 Grande Rue",
"city": "Ville neuve",
"zipcode": "01234",
"datesortie": "13/11/2020",
"heuresortie": "18:11",
"reasons" : "sport_animaux"
}
```
A PDF will be uploaded for you.
Be careful for syntax errors and remember to include the `reasons` key, too. Reasons can be `travail, achats, sante, famille, handicap, sport_animaux, convocation, missions, enfants`. If you want to select more than one reason, separate them with a comma. E.g. `"reasons" : "sport_animaux, enfants"`
### attgen.js
**attgen.js** is a modified version of the official *Attestation de déplacement dérogatoire generator* web application from Ministère de l'intérieur français, in order to be run headlessly. It is used by the telegram bot to generate the PDF, but you can import it in any javascript/node application:
```javascript
// Import attgen.js
const attgen = require('./att-gen')
// Dummy profile data
profile = {
"firstname": "name",
"lastname": "surname",
"birthday": "01/01/1991",
"placeofbirth": "Wien",
"address": "palceholder",
"city": "placeholder",
"zipcode": "01234",
"datesortie": "13/11/2020",
"heuresortie": "18:11",
}
// Reason(s)
reasons = "sport_animaux"
// Get the attestation PDF with the given data as a Buffer
attpdf = attgen.generateAtt(obj, reasons)
// Write PDF to disk
fs.appendFileSync('attestation.pdf', new Buffer.from(attpdf));
```
Bot is powered by [Telegraf.js](https://telegraf.js.org)
### Acknowledgements
Developed by [Antonio Vivace](https://github.com/avivace) and [Tobias Wallstrom](https://github.com/TobiasWallstrom).
Based on: https://github.com/LAB-MI/attestation-deplacement-derogatoire-q4-2020, https://media.interieur.gouv.fr/deplacement-covid-19/.
English reasons explanations were taken from the official English version of the attestation, accessed from https://www.interieur.gouv.fr/Actualites/L-actu-du-Ministere/Attestations-de-deplacement on 2020/11/16.