précise des détails dans le readme

This commit is contained in:
François Poulain 2020-08-25 09:02:02 +02:00
parent 7df57d5f85
commit 6402f98743
1 changed files with 13 additions and 0 deletions

View File

@ -5,6 +5,7 @@ Simple mailing script.
**Table of content**
- [Installation](#installation)
- [Input format](#input_format)
- [Licence](#licence)
## Installation
@ -29,6 +30,18 @@ following packages:
$ ./mailing.py --help
$ ./mailing.py -t test-recipients-data -b test-emailling --dry-run --verbose
## Input format
The « to-file » is expected to be csv with the [default
dialect](https://docs.python.org/3/library/csv.html?highlight=csv#dialects-and-formatting-parameters)
(`delimiter=','`, `char delimiter='"'`).
The first line is header. The `from` and `to` headers are exepected the be found.
To avoid boring repetition it is possible to declare a default column value
using `:` in header. The default value is considered when the column is lacking,
not when the column is empty.
## License
Spamotron is developed by April and licensed under the [GPLv2+](LICENSE).