https://github.com/klakshman318/pywhatkit-whatsapp-integration
Automate WhatsApp messages using pywhatkit and GitHub Actions with a self-hosted runner.
https://github.com/klakshman318/pywhatkit-whatsapp-integration
automation github-actions python pywhatkit whatsapp
Last synced: about 1 month ago
JSON representation
Automate WhatsApp messages using pywhatkit and GitHub Actions with a self-hosted runner.
- Host: GitHub
- URL: https://github.com/klakshman318/pywhatkit-whatsapp-integration
- Owner: klakshman318
- License: mit
- Created: 2025-03-18T19:06:03.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-18T20:26:16.000Z (about 1 year ago)
- Last Synced: 2025-03-18T20:28:47.044Z (about 1 year ago)
- Topics: automation, github-actions, python, pywhatkit, whatsapp
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# WhatsApp Message Automation using PyWhatKit & GitHub Actions
This repository demonstrates how to automate sending WhatsApp messages using Python's [pywhatkit](https://github.com/Ankit404butfound/PyWhatKit) library, integrated with GitHub Actions and a self-hosted runner.
## 📌 Features
- Send WhatsApp messages automatically via Python.
- Leverages `pywhatkit` to use WhatsApp Web.
- Runs using **GitHub Actions** with a **self-hosted runner** (GUI support required).
- One-time WhatsApp Web login (QR code scan), session persisted.
## 🚀 How It Works
1. Clone the repo and set up a Python script with `pywhatkit`.
2. Configure a GitHub Actions workflow.
3. Set up a self-hosted runner with browser support.
4. Run the workflow to send messages automatically.
## 🛠️ Requirements
- Python 3.10+
- `pywhatkit` library
- Self-hosted GitHub Actions runner (with GUI/browser access)
- WhatsApp Web login (QR code scan once)
## 📂 Project Structure
```bash
.
├── send_message.py # Python script to send WhatsApp message via pywhatkit
├── requirements.txt # Python dependencies file
├── README.md # Project documentation
└── .github
└── workflows
└── send-message.yml # GitHub Actions workflow to run the message script
```
## 📦 Installation & Usage
### 1. Install Dependencies
```bash
pip install -r requirements.txt
```
### 2. Run Script Locally (Test)
```bash
python send_message.py
```
### 3. Set Up Self-Hosted Runner
Follow GitHub’s official guide for setting up a self-hosted runner.
### 4. Trigger GitHub Action
Go to GitHub → Actions tab → Run the workflow manually.
## ❓ FAQ
### 1. Why do I need a self-hosted runner?
`pywhatkit` opens WhatsApp Web in a browser, which is not supported on GitHub's cloud runners. A self-hosted runner with GUI/browser support is required.
### 2. Do I need to scan the WhatsApp QR code every time?
No, you only need to scan the QR code once. The session will persist unless you log out or clear browser data.
### 3. Can I schedule messages instead of sending instantly?
Yes! Use `pywhatkit.sendwhatmsg(phone_no, message, time_hour, time_min)` for scheduled messages.
## 🛠️ Troubleshooting
- **Error: Browser not opening or script hangs**
- Ensure your self-hosted runner machine has a GUI and a default browser installed.
- Try running the script locally first to verify.
- **QR Code appears every time**
- Make sure your browser retains session/cookies. Don’t clear site data for WhatsApp Web.
- **GitHub Action stuck on 'Running'**
- Check that your self-hosted runner is active and terminal window is running `./run.sh`.
- **Permission Denied (Linux)**
- Run: `chmod +x ./run.sh` and `chmod +x ./config.sh`
## 🤝 Contributing
Contributions are welcome! If you find a bug or have a feature request, open an issue or submit a pull request.
1. Fork the repo
2. Create a new branch
3. Commit changes
4. Push and create a PR
