https://github.com/tejasambhore/whatsapp_formatter
Convert Markdown and HTML to WhatsApp formatting in Python
https://github.com/tejasambhore/whatsapp_formatter
chatbot converter formatter html markdown messaging python text-formatting whatsapp whatsapp-api
Last synced: 15 days ago
JSON representation
Convert Markdown and HTML to WhatsApp formatting in Python
- Host: GitHub
- URL: https://github.com/tejasambhore/whatsapp_formatter
- Owner: TejasAmbhore
- License: mit
- Created: 2026-01-21T12:08:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-02-09T11:19:57.000Z (4 months ago)
- Last Synced: 2026-04-04T02:15:30.564Z (2 months ago)
- Topics: chatbot, converter, formatter, html, markdown, messaging, python, text-formatting, whatsapp, whatsapp-api
- Language: Python
- Homepage: https://github.com/TejasAmbhore/whatsapp_formatter
- Size: 23.4 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-whatsapp-formatter: Python Library for WhatsApp Text Formatting
**Convert Markdown and HTML to WhatsApp formatting in Python** — A lightweight, zero-dependency library for bidirectional conversion between WhatsApp, Markdown, and HTML text formatting. Perfect for WhatsApp chatbots, messaging automation, WhatsApp Business API integrations, and any application that needs to format text for WhatsApp messages.
**Key Features:**
- 🔄 Bidirectional conversion (to and from WhatsApp format)
- 📝 Supports Markdown ↔ WhatsApp and HTML ↔ WhatsApp
- 🎯 Zero dependencies, fully typed
- ⚡ Fast and lightweight
- 🔗 Handles nested formatting correctly
## Installation
```bash
pip install py-whatsapp-formatter
```
## Use Cases
- **WhatsApp Chatbots**: Format bot responses with proper WhatsApp styling
- **WhatsApp Business API**: Convert rich text to WhatsApp-compatible format
- **Content Management**: Transform CMS content (HTML/Markdown) for WhatsApp
- **Message Automation**: Programmatically format WhatsApp messages
- **AI Chat Integration**: Convert ChatGPT/Claude markdown responses to WhatsApp format
## Usage
### Convert to WhatsApp Format
```python
from whatsapp_formatter import convert_markdown_to_whatsapp, convert_html_to_whatsapp
# Convert Markdown to WhatsApp format
text = convert_markdown_to_whatsapp("**Bold** and *italic* and ~~strikethrough~~")
# Output: "*Bold* and _italic_ and ~strikethrough~"
# Convert HTML to WhatsApp format
text = convert_html_to_whatsapp("Bold italic")
# Output: "*Bold* _italic_"
```
### Convert from WhatsApp Format
```python
from whatsapp_formatter import convert_whatsapp_to_markdown, convert_whatsapp_to_html
# Convert WhatsApp to Markdown format
text = convert_whatsapp_to_markdown("*Bold* and _italic_ and ~strikethrough~")
# Output: "**Bold** and *italic* and ~~strikethrough~~"
# Convert WhatsApp to HTML format
text = convert_whatsapp_to_html("*Bold* and _italic_ and ~strikethrough~")
# Output: "Bold and italic and strikethrough"
```
## WhatsApp Formatting Reference
| Format | WhatsApp | Markdown | HTML |
|--------|----------|----------|------|
| Bold | `*text*` | `**text**` | ``, `` |
| Italic | `_text_` | `*text*` | ``, `` |
| Strikethrough | `~text~` | `~~text~~` | ``, ``, `` |
| Monospace | `` `text` `` | `` `text` `` | `` |
| Code block | ` ```text``` ` | ` ```text``` ` | `` |
All conversions are bidirectional. Nested formatting is supported (e.g., `*_bold and italic_*`).
## Advanced Usage
For more control, use the converter classes directly:
```python
from whatsapp_formatter import (
MarkdownToWhatsAppConverter,
HTMLToWhatsAppConverter,
WhatsAppToMarkdownConverter,
WhatsAppToHTMLConverter,
)
# Custom Markdown converter with post-processing
converter = MarkdownToWhatsAppConverter()
converter.add_post_processor(lambda x: x.strip())
result = converter.convert(" **Hello** ")
# HTML converter without tag stripping
converter = HTMLToWhatsAppConverter(strip_remaining_tags=False)
result = converter.convert("Bold kept")
# WhatsApp to Markdown
converter = WhatsAppToMarkdownConverter()
result = converter.convert("*bold* _italic_ ~strike~")
# Output: "**bold** *italic* ~~strike~~"
# WhatsApp to HTML (with optional line break conversion)
converter = WhatsAppToHTMLConverter(include_line_breaks=True)
result = converter.convert("*bold*\n_italic_")
# Output: "bold
\nitalic"
```
## Requirements
- Python 3.9+
- No external dependencies
## License
MIT License