diff --git a/README.md b/README.md new file mode 100644 index 0000000..fb332c0 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# DMARC Reports analyzer using IMAP connection + +## Installation: + +- Create a virtualenv +- Install packages from requirements.txt (`python -m pip install -r requirements.txt`) +- Create a configuration: `python analyze.py -c --recreate` +- Adjust the initial values in your `` +- Initialize the sqlite3 db: `python analyze.py -c --init-db` + +## Usage: + +After you've set up the configuration, run the utility with only the config file parameter `-c ` to collect the results into the sqlite db. +If you want to load the collected reports and send them in a summarized email, use the `--report` option. + +## Command line help + +`python analyze.py -h`