Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielcardeenas/whatsapp-framework
⚗️Whatsapp python api
https://github.com/danielcardeenas/whatsapp-framework
api bot framework python whatsapp whatsapp-api whatsapp-bot whatsapp-framework
Last synced: about 2 months ago
JSON representation
⚗️Whatsapp python api
- Host: GitHub
- URL: https://github.com/danielcardeenas/whatsapp-framework
- Owner: danielcardeenas
- Created: 2016-11-18T20:04:41.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-10T20:42:42.000Z (over 4 years ago)
- Last Synced: 2024-06-05T17:58:11.926Z (4 months ago)
- Topics: api, bot, framework, python, whatsapp, whatsapp-api, whatsapp-bot, whatsapp-framework
- Language: Python
- Homepage:
- Size: 25.1 MB
- Stars: 1,151
- Watchers: 119
- Forks: 362
- Open Issues: 146
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Warning
> Whatsapp blocks numbers now. Framework wont work properly until next version
>
> Meanwhile heres a better alternative: [**project sulla**](https://github.com/danielcardeenas/sulla)
# mac (Whatsapp framework)
Mac is a whatsapp bot/framework I made as a weekend project. The project itself has all you need to make your own custom bot easily.
Mac has built-in human behavior so you only have to worry about the functions you make. Every module works completely separated from the core, this means that you can erease every module and mac will keep working
_This needs **Python 3.5**_
# Setup:
1. Clone this repository (with submodules since it uses tgalal's yowsup library)
```sh
> git clone https://github.com/danielcardeenas/whatsapp-framework.git
```
2. Run setup.sh (Most likely on sudo since its going to install some libraries)
```sh
> sudo ./setup.sh
```
3. Register your phone and get a password with like this:
```sh
# Replace CC with your country code (See https://countrycode.org)
> yowsup-cli registration --requestcode sms --phone CCXXXXXXXX --cc CC -E android
# After getting the sms code (in this example: 123456)
> yowsup-cli registration --register 123456 --phone CCXXXXXXXX --cc CC -E android
```
4. Open **config.py** and add set your credentials
5. Ready to go! (Now you can add your own whatsapp modules)
```sh
> ./start.sh
```
# Quickstart
Create your own module inside [`modules/`](https://github.com/danielcardeenas/whatsapp-framework/tree/master/modules) directory
```python
# modules/hi_module.py
from app.mac import mac, signals
@signals.message_received.connect
def handle(message):
if message.text == "hi":
mac.send_message("Hello", message.conversation)
# Can also send media
#mac.send_image("path/to/image.png", message.conversation)
#mac.send_video("path/to/video.mp4", message.conversation)
```
Now you should only add it into [`modules/__init__.py`](https://github.com/danielcardeenas/whatsapp-framework/blob/master/modules/__init__.py) to enable the module
```python
# modules/__init__.py
...
from modules import hi_module
...
```
And that's it! You are ready to go.
###### If your module needs libraries from pip you should add them into a `requirements.txt` and run `sudo ./setup.sh` to download the dependencies
###### _You can take [`hihelp module`](https://github.com/danielcardeenas/whatsapp-framework/blob/master/modules/hihelp/hihelp.py) as an example._
# Updates
The project is not submoduling yowsup now due to a lot of the modifications made are focused for this project only and to make things simpler.
- [x] Notification on messages receipt (received and blue check marks)
- [x] Get contacts statuses
- [x] Get contacts profile picture (also from groups)
- [x] Set profile picture (also from groups)
- [x] Send videos (needs ffmpeg installed)
- [x] Add support for @tag messages
- [x] Add support for reply messages
- [x] Add support for receiving images
- [x] Add support for big receiving big files (downloading and decryption done in chunks)
- [x] Add support for sending images
- [ ] Add support for encrypting images in chunks (_TODO_)
- [ ] Add pickle support to remember the messages when mac its turned off(_TODO_)
# Example screenshots:
# Wiki
[Read this](https://github.com/danielcardeenas/whatsapp-framework/wiki/Do-not-get-banned)