2021-10-17 13:06:19 +02:00
|
|
|
# mensa
|
2020-01-29 17:52:40 +01:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
CLI tool to query the menu of canteens contained in the [OpenMensa](https://openmensa.org) database.
|
2019-04-11 17:40:04 +02:00
|
|
|
|
2021-10-14 10:15:02 +02:00
|
|
|
![example](https://user-images.githubusercontent.com/11077981/137278085-75ec877a-dba0-44bb-a8dc-6c802e24178c.png)
|
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
## Features
|
2019-04-11 17:40:04 +02:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
- [X] Custom filters and favourites using CLI flags or the
|
|
|
|
optional configuration file.
|
|
|
|
- [X] List canteens close to you based on GeoIP.
|
2021-10-14 10:10:42 +02:00
|
|
|
- [X] All request are cached locally.
|
2021-10-17 13:06:19 +02:00
|
|
|
- [X] Fuzzy date parsing based on
|
|
|
|
[date_time_parser](https://lib.rs/crates/date_time_parser).
|
|
|
|
- [ ] List your favourite meals in canteens close to your location.
|
2019-04-11 17:40:04 +02:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
## Installation
|
2019-04-11 17:40:04 +02:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
### Cargo
|
2021-10-14 10:32:24 +02:00
|
|
|
|
|
|
|
```console
|
|
|
|
$ cargo install --git https://github.com/MalteT/mensa
|
|
|
|
```
|
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
### Nix
|
2021-10-14 10:32:24 +02:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
This is a [Nix Flake](https://nixos.wiki/wiki/Flakes), add it
|
|
|
|
to your configuration or just test the application with:
|
2021-10-14 10:32:24 +02:00
|
|
|
|
|
|
|
```console
|
|
|
|
$ nix run github:MalteT/mensa
|
|
|
|
```
|
2019-04-11 17:41:30 +02:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
## Usage
|
2019-04-11 17:41:30 +02:00
|
|
|
|
2021-10-14 10:32:24 +02:00
|
|
|
See `mensa --help`.
|
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
- `mensa` will show meals served today for the default canteen mentioned
|
|
|
|
in the configuration.
|
2021-10-14 12:23:52 +02:00
|
|
|
If no such configuration exists, try `mensa --id 63`.
|
|
|
|
You can find the id for your canteen using
|
2021-10-17 13:06:19 +02:00
|
|
|
- `mensa canteens` lists canteens near you based on your current
|
|
|
|
IP in a default radius of 10km.
|
2021-10-14 10:32:24 +02:00
|
|
|
- `mensa tags` will list the currently known meal tags like "**12** Nuts".
|
|
|
|
|
2019-04-11 17:40:04 +02:00
|
|
|
|
2021-10-17 13:06:19 +02:00
|
|
|
## Configuration
|
2019-04-11 17:40:04 +02:00
|
|
|
|
2021-10-14 10:32:24 +02:00
|
|
|
See [config.toml](config.toml) for an example. Copy the file to:
|
|
|
|
- `$XDG_CONFIG_DIR/mensa/config.toml` on **Linux**,
|
|
|
|
- `$HOME/Library/Application Support/mensa/config.toml` on **macOS**,
|
2021-10-17 13:06:19 +02:00
|
|
|
- ~~`{FOLDERID_RoamingAppData}\mensa\config.toml` on **Windows**~~
|
|
|
|
I don't think it'll run on Windows.. 🤷♀️
|
|
|
|
|
|
|
|
License: MIT OR Apache-2.0
|