Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/homemadepy/messages

A python package designed to make sending messages easy and efficient!
https://github.com/homemadepy/messages

api api-wrapper automation beginner-friendly cli email python3 slack smtp telegram tool tools twilio whatsapp wiki

Last synced: 29 days ago
JSON representation

A python package designed to make sending messages easy and efficient!

Awesome Lists containing this project

README

        

# Messages: Create and send messages fast!
[![](https://img.shields.io/badge/built%20with-Python3-red.svg)](https://www.python.org/)
[![PyPI version](https://badge.fury.io/py/messages.svg)](https://badge.fury.io/py/messages)
[![](https://app.travis-ci.com/HomeMadePy/messages.svg?branch=master)](https://app.travis-ci.com/github/HomeMadePy/messages)
[![Coverage Status](https://coveralls.io/repos/github/HomeMadePy/messages/badge.svg?branch=master)](https://coveralls.io/github/HomeMadePy/messages?branch=master)
[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/HomeMadePy/messages/blob/master/LICENSE)

![messages_words](https://user-images.githubusercontent.com/18299151/48576493-c0a68380-e925-11e8-9322-eb5bd67858a4.png)

## Purpose
- **Messages** is a package designed to make sending messages easy and efficient!
- **Messages** intends to be a _lightweight_ package with minimal dependencies.
- **Messages** with a **consistent API** across all message types.
- **Messages** includes **asynchronous** support for fast message handling.

## Installation
**Python3 only**
```shell
$ pip install messages
```

## Documentation in the [Wiki](https://github.com/HomeMadePy/messages/wiki)

## Supported Messages
* [Email](https://github.com/HomeMadePy/messages/wiki/Email)
* [Telegram](https://github.com/HomeMadePy/messages/wiki/TelegramBot)
* [Twilio](https://github.com/HomeMadePy/messages/wiki/Twilio)
* [WhatsApp](https://github.com/HomeMadePy/messages/wiki/WhatsApp)
* **Read the [Wiki](https://github.com/HomeMadePy/messages/wiki) for usage**.

# Examples
### Synchronous Execution
```python3
# You can send messages right in the REPL

>>> from messages import Email
>>>
>>> m = Email(
from_ = "[email protected]",
to = "[email protected]",
auth = "p@ssw0rd",
subject = "Good Advice",
body = "Hello,\n\tBuy more Bitcoin!",
attachments = ["./file1.txt", "~/Documents/file2.pdf"],
)
>>>
>>> m.send()
Message sent...
```

### Asynchronous Execution
```python3
# You can also send messages inside a script

import asyncio

from messages import Email

RECIPIENTS = [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
]

loop = asyncio.get_event_loop()

for r in RECIPIENTS
e = Email(
from_ = "[email protected]",
to = r,
auth = "p@ssw0rd",
subject = "Good Advice",
body = "This is an asynchronous email.\nContinue buying more Bitcoin!",
attachments = ["./file1.txt", "~/Documents/file2.pdf"],
)

loop.create_task(e.send_async())

tasks = asyncio.all_tasks(loop=loop)
group = asyncio.gather(*tasks)
loop.run_until_complete(group)
```

### **Read** the [Wiki](https://github.com/HomeMadePy/messages/wiki) for **more examples**

## Contributing Code

* **Help Wanted!**
* All contributions are welcome to build upon the package!
* If it's a **message**, add it to messages!
* Read the [Wiki](https://github.com/HomeMadePy/messages/wiki) for guidelines.