windbell 0.0.3

JSON + Mustache for fast email delivery

Copyright (c) 2018 Hawkins Zhao

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: # windbell

**windbell** is a Python email delivery tool which is easy to use and easy to integrate. Your can use windbell via both CLI and Python code.

[]()

# Usage

## Installation
```bash
pip install windbell

# Run with no args for the first time initialization.
windbell
```

## Send email

### CLI:

```bash
windbell send -t /path/to/template.mst -d '{"foo": "bar"}' -s 'some_subject'
```

Arguments
- -t, --template Mustache syntax template file path
- -d, --data JSON data for rendering
- -s, --subject Email subject

### Python:

```python
import windbell as wb

t = open('base.mst', 'r').read()
d = {'foo': 'bar'}

wb.send('windbell lib test', t, d)
```

### Parameters
- `subject` email subject
- `template` mustache syntax template
- `data` dict data for rendering
- `attachment` *[optional]* attachment content tuple, default is `()`
- `receiver` *[optional]* email receiver, default is `None`
- `smtp_server` *[optional]* SMTP server, default is None
- `sender_email` *[optional]* sender email, default is None
- `sender_pwd` *[optional]* sender password, default is None
- `sender_name` *[optional]* sender name, default is None

optional parameters will fetch its value from config file when it is set to `None`

## Change configs

*Config change only support in CLI. To change config in Python, you could pass config dict in send function.*

```bash
windbell config -k foo -v value
```

### Arguments
- -l, --list list all configs
- -k, --key config item key
- -v, --value config item value

Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown