BotZ/README.md
Leonardo Barcaroli 2712c717d7 Fix the README
2019-01-21 15:58:13 +01:00

40 lines
962 B
Markdown

Bot_Z
=====
A bot to easen the daily routine with zucchetti virtual badge.
* Free software: GLWTS public licence.
Features
--------
* Login/Logout
* Check in/Check out
Install
-------
Either clone this repo and `pip install .` or use one of the provided packages.
Pay attention: this package needs a working binary of [geckodriver](https://github.com/mozilla/geckodriver).
You can either proceed in one of the following ways:
* Install the source distribution and put in your `$PATH` the `geckodriver` binary
(that can be downloaded [here](https://github.com/mozilla/geckodriver/releases/))
* Install the wheel for your architecture
* `pip install .` or `pip install -e .` will download the latest `geckodriver` and
put it in a path where the code will be able to find it.
*BEWARE*: the code gives precedence to the `geckodriver` in `$PATH` over that donwloaded.
TODO
----
- [x] Check in/out
- [ ] systemd {unit, timer}
- [ ] APIs
- [ ] Mailer