parcolar

README

Personal Telegram bot for education

Add the bot — License

🌈 Features

• Fetch homework and timetable for the coming days directly from PRONOTE (French software for school life)
• Do some maths: calculating, plotting, LaTeX rendering
• Search data over educational establishments (Parcoursup), translations of words and sentences, word definitions in the dictionary

💻 Development

Thanks for participating in Parcolar's improvement and/or debugging! First, check the following requirements:

• Git, for version control
• Golang 1.16 or higher with go-modules for dependencies
• A running instance of Redis v5 or higher
• A running instance of pronote-api for PRONOTE-related commands Unfortunately, due to legal restrictions in France, PRONOTE can't be used any more through their API
• TeX Live for the pdflatex program (with default LaTeX packages)
• ImageMagick for the convert program ⚠ Make sure to authorize PDF read and write in the policy.xml file of your installation

Clone the project on your local machine:

git clone https://github.com/theovidal/parcolar  # HTTP
git clone git@github.com:theovidal/parcolar      # SSH

Set up some environment variables described in the .env.example file, either by adding them in the shell or by creating a .env file at the root of the project.

To run and test the bot, simply use go run . in the working directory. To build an executable, use go build ..

📜 Credits

• Maintainer: Théo Vidal
• Libraries: check go.mod
• Services: pronote-api, OpenData, WordReference, DeepL, Larousse
• Programs: TeX Live, ImageMagick, Redis

🔐 License

GNU GPL v3