windbell 0.1.4

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 an email delivery tool which is easy to use via CLI and easy to integrate as a python package. Windbell also features a flexible email development and testing environment.

<!–  –>

Windbell is still under early development. Issues or pull requests are welcome!

# Concept

Windbell requires no system or user level configuration, and produce nothing after installation either. All you need is a [windfile](https://github.com/HawkinsZhao/windbell/blob/master/docs/windfile.md). So, you could just place it to where you need, then run windbell send.

For example, if you want to send email in a CI pipeline of a git repo, you could just place your windfile in the root of your repo, then use a [windbell docker](https://hub.docker.com/r/hawkinszhao/windbell) to send the email. See our instructions about [integration](https://github.com/HawkinsZhao/windbell/blob/master/docs/integrate.md).

# Usage

If you want to use windbell as a python package, please checkout [here](https://github.com/HawkinsZhao/windbell/blob/master/docs/usage.md).

## Installation

`bash pip install windbell `

## Start Your Project

`bash windbell init `

> init command will create a windfile in current working dictronary. A windfile is the key to your email delivery workflow, it contains email template and configurations.

`bash windbell dev `

Open http://localhost:9000 to use the integrated email development enviroment.

> dev command allows you develop your email project in the browser under a flexible intergrated environment. More detailed structure about windfile please refer to doc.

`bash windbell send `

> send command will read the windfile at current dictionary and send to the receviers defined in windfile.

# License

Windbell © [Hawkins Zhao](https://github.com/HawkinsZhao), Released under the MIT License.

Authored and maintained by Hawkins Zhao with help from contributors.

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