Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lcarnevale committed Apr 1, 2021
1 parent a6266d8 commit 04f9669
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# MailSend Command Line Interface
# Call For Paper Invitation Bot

<img src="https://img.shields.io/badge/python-v3-blue" alt="python-v3-blue">

While the management of special issues, workshop and conferences becomes more complex, automatic tools come to the rescue. This project includes a simple command line program to send email via Google API. Suggestions and bug reports are always welcome. If you have any question, request or suggestion, please enter it in the Issues with appropriate label.


## Get Google Credendials
Follow the instructions [here](https://developers.google.com/gmail/api/quickstart/python) to download the credential JSON file required to run the *c4pinvitation-email-bot*.

## How to build it
Download latest release [here]() and make up the virtual environment.

```bash
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements.txt
```

## How to use it
The application strongly requires a list of recipients, the email subject and the body. The list of carbon copy recipients is instead optional. These parameters must be stored within independent files as follow.

<p align="center">
<img src="pics/emails-to-sample.png">
<br>
<em>Example of emails to</em>
<br> <br>
<img src="pics/emails-body-sample.png">
<br>
<em>Example of emails body</em>
</p>

Run then the application as follow.

```bash
python main.py \
--to <PATH/OF/TO-FILE> \
--subject "try it out" \
--body <PATH/OF/BODY-FILE>
```

0 comments on commit 04f9669

Please sign in to comment.