An open API service indexing awesome lists of open source software.

https://github.com/literateink/pawdirecte.rs

A purrfect API wrapper for EcoleDirecte written in Rust.
https://github.com/literateink/pawdirecte.rs

api ecoledirecte wrapper

Last synced: 11 months ago
JSON representation

A purrfect API wrapper for EcoleDirecte written in Rust.

Awesome Lists containing this project

README

          

Pawdirecte: A purrfect API wrapper for EcoleDirecte

_This library **is not** affiliated with [↗ Aplim](https://www.aplim.fr/) or [↗ EcoleDirecte](https://www.aplim.fr/EcoleDirecte) in any way._

## What is "EcoleDirecte" ?

[↗ EcoleDirecte](https://www.aplim.fr/EcoleDirecte) is an online platform used by schools to facilitate communication and administrative management. It gives teachers, students and parents access to information such as timetables, grades, absences, homework and messages.

## Installation

```bash
cargo add pawdirecte
```

## Quick Start

Please take a look at the [`login_with_double_auth` example](./examples/login_with_double_auth.rs) to know how to authenticate.

You can find guides at [**↗ pawdirecte.docs.literate.ink**](https://pawdirecte.docs.literate.ink) and if it's not enough you can also take a look at the [**↗ examples** directory on the GitHub repository](https://github.com/LiterateInk/Pawdirecte.rs/tree/main/examples) for inspiration.

If none of those are helpful, you can always [↗ open an issue](https://github.com/LiterateInk/Pawdirecte.rs/issues) to ask for help or join the [↗ LiterateInk Discord server](https://literate.ink/discord).

## Acknowledgements

- [EduWireApps' EcoleDirecte API documentation](https://github.com/EduWireApps/ecoledirecte-api-docs)

## License

This project is licensed under the GPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details.