Hermes is a simple slack notification tool that watches for unseen messages on multiple emails!
Hermes is written in Python3.9 and uses Slack Incoming Webhook.
It is build on top of Click CLI with Pydantic for data parsing and validation and also uses:
Before installing the application, make sure all the dependencies are resolved.
The application and its dependencies are fully containerized and rely on docker to manage the containers and uses of Make as our build automation tool.
So, if you don't have them installed already, please follow the links below:
Also make sure to create Slack Incoming Webhook
Once the dependencies are installed, just follow the simple steps below to have the application up and running.
Clone the repo and change the directory to the newly cloned folder.
git clone https://github.com/zydneyambat/hermes.git
cd hermes
Create a config yaml file based on config.yaml.dist and follow the instruction there.
cp config.yaml.dist config.yaml
Use the command make
to trigger the installation.
make
The make
command build the image, configure dependencies and install the application.
When the command is finished you can now watch your email inbox by running the command below:
make run ./config.yaml
Note: You can simply run make
or make help
for a list of all available commands.
To run the unit tests simply call make test
.
It will use run the testing container and run the unit tests.
The coverage/index.html can be found on the root folder.