https://github.com/theovidal/parcolar

💼 Personal Telegram bot for education
https://github.com/theovidal/parcolar

golang-application maths school school-stuff telegram-bot translation

Last synced: about 1 month ago
JSON representation

💼 Personal Telegram bot for education

• Host: GitHub
• URL: https://github.com/theovidal/parcolar
• Owner: theovidal
• License: gpl-3.0
• Created: 2021-02-04T21:06:11.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-09-05T19:50:06.000Z (over 3 years ago)
• Last Synced: 2024-06-20T13:39:55.134Z (7 months ago)
• Topics: golang-application, maths, school, school-stuff, telegram-bot, translation
• Language: Go
• Homepage: https://t.me/ParcolarBot
• Size: 1.6 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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

![Preview of the commands](./assets/commands-preview.jpeg)

## 💻 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](https://redis.io/) v5 or higher

- ~~A running instance of [pronote-api](https://github.com/Litarvan/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](https://www.tug.org/texlive/acquire-netinstall.html) for the `pdflatex` program (with default LaTeX packages)

- [ImageMagick](https://imagemagick.org/index.php) 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:

```bash

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

git clone [email protected]:theovidal/parcolar      # SSH

```

Set up some environment variables described in the [.env.example file](./.env.example), 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](https://github.com/theovidal)

- Libraries: [check go.mod](./go.mod)

- Services: ~~[pronote-api](https://github.com/Litarvan/pronote-api)~~, [OpenData](https://data.enseignementsup-recherche.gouv.fr/explore/dataset/fr-esr-parcoursup/information/?timezone=Europe%2FBerlin&disjunctive.fili=true&sort=tri), [WordReference](https://www.wordreference.com/), [DeepL](https://deepl.com), [Larousse](https://larousse.fr)

- Programs: [TeX Live](https://www.tug.org/texlive), [ImageMagick](https://imagemagick.org/index.php), [Redis](https://redis.io/)

## 🔐 License

[GNU GPL v3](./LICENSE)