Metadata-Version: 2.1
Name: communicationAppModule
Version: 0.2.2
Summary: Module to connect with communication app and send message
Author: Wayne Shang
Author-email: wayne18308@gmail.com
License: MIT
Keywords: Communication App
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

# communication app bot

## what is this
This project is amied to create a python package can easily send message to any communication app

> Support telegram right now, fell free to let me know which app you want to have this function

### Installing

```
pip3 install communicationAppModule
```

### prerequisite

* Telegram
>create a bot via botfather to get a bot token

### Create Client
```py
# bot token only for telegram
# db_name optional
# log_file_name optional
from communicationApp import *
client = createClient('Telegram', bot_token ='', db_name ='', log_file_name='')
```

### Send Message
```py
# send single sentence
client.send_message("hi")

# send multi line
client.send_message(['hi','John', 'this is wayne'])
```


### Send Photo
```py
# send photo from url
client.send_photo({'photo_url': photo_url})

# send photo from telegram file id
client.send_photo({'file_id': file_id})

#send photo from file
file = open('path', 'rb')
client.send_photo({'file': file})

```

### Get message
```py
# send last response
client.get_response()

# get multi responses
client.get_response(10)
```

### Response Format
```json
{
"status_code": 200, 
"data": [{
    "user_info":{},
    "date": "timestamp",
    "text": "string"
    }],
"error": "string"
}

```


Change Log
==========

0.1 (06/03/2022)
-------------------
- First Release

0.2.0 (10/04/2022)
-------------------
- add send photo feature


0.2.1 (10/04/2022)
-------------------
- fix bug

0.2.2 (10/04/2022)
-------------------
- fix bug

