Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Labfox authored Aug 15, 2024
1 parent 72e71c8 commit 725b85a
Showing 1 changed file with 13 additions and 35 deletions.
48 changes: 13 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,55 +3,33 @@

WhatsApp web wrapper in Python. No selenium nor gecko web driver needed.

Setting up browser driver are tricky for python newcomers, and thus it makes your code so 'laggy'.

I knew that feeling. It's so painful.

So I make WhatsFly, implementing Whatsmeow --a golang based WhatsApp library. It will make his wrapper easy to use without sacrificing the speed and perfomance.
Setting up browser driver is tricky for python newcomers, and thus it makes your code so 'laggy' while using lots of ram.

## Installation

```bash
pip install whatsfly
```

or :
```bash
pip install --upgrade whatsfly
```

## Usage/Examples

```javascript
from whatsfly import WhatsApp

chat = WhatsApp()

# send mesage
chat.send_message(phone="6283139750000", message="Hello World!")

# send image
chat.send_image(phone="6283139750000", image_path="path/to/image.jpg" caption="Hello World!")
pip install git+https://github.com/Labfox/whatsfly
```

## Features
## Documentation

First page on the docs
https://whatsfly.readthedocs.io/en/latest

## Supported machines

The library theorically support every machine with go and cgo, but if the builds fails on your machine, there are pre-built binaries auto-downloaded for the following architectures:

| Architecture | Status |
| ------------- | ------------- |
| Linux amd64 ||
| Linux ARM64 | |
| Linux 686 | |
| Linux 386 | |
| Linux ARM64 | GH Worlflow error |
| Linux 686 | GH Worlflow error |
| Linux 386 | GH Worlflow error |
| Windows amd64 ||
| Windows 32 bit | soon! |
| OSX arm64 | soon! |
| OSX amd64 | soon! |
| Windows 32 bit | GH Worlflow error |
| OSX arm64 | |
| OSX amd64 | |

> ## Support this Project
> This project is maintained during my free time.
## Contributing
> If you'd like to support my work, please consider making a pull request to help fix any issues with the code.
> I would like to extend my gratitude to the open-source developers behind tls-client, tiktoken, and whatsmeow. Their work has inspired me greatly and helped me to create this project.

0 comments on commit 725b85a

Please sign in to comment.