Skip to content

Commit

Permalink
Merge pull request #13 from Burhanuddin-2001/Readme_update
Browse files Browse the repository at this point in the history
Enhanced README and documentation
  • Loading branch information
anupammaurya6767 authored Jan 8, 2024
2 parents a2d2214 + 73ddc12 commit 32ee122
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 26 deletions.
16 changes: 13 additions & 3 deletions DEMON_CONNECT_DOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Unleash the demon within to navigate the WhatsApp Web universe and experience th
```python
whatsapp_demon = Demon(browser='chrome', browser_path='path/to/browser', driver_path='path/to/driver')
```
<br/>

### `load_driver(self)`

Expand All @@ -29,6 +30,7 @@ whatsapp_demon = Demon(browser='chrome', browser_path='path/to/browser', driver_
```python
whatsapp_demon.load_driver() # Prepare the gateway to WhatsApp Web! 🪄
```
<br/>

### `login(self)`

Expand All @@ -38,6 +40,7 @@ whatsapp_demon.load_driver() # Prepare the gateway to WhatsApp Web! 🪄
```python
whatsapp_demon.login() # Begin your epic quest! 🛡️
```
<br/>

### `send_message(self, contact_name: str, message: str)`

Expand All @@ -50,6 +53,7 @@ whatsapp_demon.login() # Begin your epic quest! 🛡️
```python
whatsapp_demon.send_message("Fellow Adventurers", "Brace yourselves, a new quest awaits! 🌄")
```
<br/>

### `send_image(self, contact_name: str, picture: Path, message: Optional[str] = None)`

Expand All @@ -63,6 +67,7 @@ whatsapp_demon.send_message("Fellow Adventurers", "Brace yourselves, a new quest
```python
whatsapp_demon.send_image("Fellow Explorers", "path/to/your/image.jpg", "A glimpse of our adventure! 📸")
```
<br/>

### `send_video(self, contact_name: str, video: Path, message: Optional[str] = None)`

Expand All @@ -76,6 +81,7 @@ whatsapp_demon.send_image("Fellow Explorers", "path/to/your/image.jpg", "A glimp
```python
whatsapp_demon.send_video("Adventurers Guild", "path/to/your/video.mp4", "Our adventures await! 🌟")
```
<br/>

### `delete_message(self, group_name: str, message: str)`

Expand All @@ -88,6 +94,7 @@ whatsapp_demon.send_video("Adventurers Guild", "path/to/your/video.mp4", "Our ad
```python
whatsapp_demon.delete_message("Secret Society", "This message is better left unsaid.")
```
<br/>

### `tag_all(self, group_name: str)`

Expand All @@ -99,6 +106,7 @@ whatsapp_demon.delete_message("Secret Society", "This message is better left uns
```python
whatsapp_demon.tag_all("Guild Members") # Gather, brave souls! 🚀
```
<br/>

### `get_list_of_messages(self)`

Expand All @@ -112,6 +120,7 @@ messages = whatsapp_demon.get_list_of_messages()
for message in messages:
print(f"Sender: {message.sender}, Timestamp: {message.timestamp}, Content: {message.content}")
```
<br/>

### `send_file(self, contact_name: str, filename: Path, message: Optional[str] = None)`

Expand All @@ -125,6 +134,7 @@ for message in messages:
```python
whatsapp_demon.send_file("Scroll Keepers", "path/to/ancient-scroll.pdf", "The wisdom of the ancients. 📜")
```
<br/>

### `fetch_all_unread_chats(self, limit: bool = True, top: int = 50)`

Expand All @@ -137,6 +147,7 @@ whatsapp_demon.send_file("Scroll Keepers", "path/to/ancient-scroll.pdf", "The wi
```python
unread_chats = whatsapp_demon.fetch_all_unread_chats(top=10) # The uncharted chats reveal their secrets! 🌟
```
<br/>

### `logout(self)`

Expand All @@ -146,14 +157,13 @@ unread_chats = whatsapp_demon.fetch_all_unread_chats(top=10) # The uncharted ch
```python
whatsapp_demon.logout() # Farewell, brave adventurer! Your journey continues elsewhere. 🏰
```
<br/>

### `close(self)`

- **👋 Purpose**: Close the magical gateway, freeing your browser from the spells and releasing the captive resources. Break the spell of the digital world! 👋

**

Usage Example**:
**Usage Example**:
```python
whatsapp_demon.close() # Farewell, until we meet again! 👋
```
Expand Down
89 changes: 66 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,52 @@
# 🌟 Demon Connect - WhatsApp API 🌟

<img align='right' src="https://github.com/anupammaurya6767/Demon_connect/blob/main/main.png" width="230">
<img align='right' src="https://github.com/anupammaurya6767/Demon_connect/blob/main/assets/main.png" width="230">

<p align="center">
<a href="#Overview">Overview</a> •
<a href="#Features">Features</a> •
<a href="#Usage">Usage</a> •
<a href="#Installation">Installation</a> •
<a href="#Contributing">Contributing</a> •
<a href="#License">License</a>
<a href="#overview-">Overview</a> •
<a href="#features-">Features</a> •
<a href="#usage-">Usage</a> •
<a href="#installation">Installation</a> •
<a href="#contributing-">Contributing</a> •
<a href="#license-">License</a>
</p>
<br/>
<p align="center">
<a href="https://pypi.org/project/demon-connect/">
<img src="https://img.shields.io/badge/demon-connect?logo=pypi&logoColor=blue&label=demon-connect&labelColor=white&color=black" alt="Demon" />
</a>
<img src="https://readthedocs.org/projects/demon_connect/badge/?version=latest" alt="Docs" ><a href="https://demon-connect.readthedocs.io/" /></img>
<img src="https://img.shields.io/github/license/anupammaurya6767/Demon_connect" alt="License" ><a href="#" /></img>
<a href="https://chat.whatsapp.com/FGV7ef4d9tNGtfN8HDvbim"><img src="https://badges.aleen42.com/src/whatsapp.svg" alt="Whatsapp" /></a>
<img src="https://img.shields.io/badge/demon-connect?style=plastic&logo=pypi&logoColor=blue&label=demon-connect&labelColor=white&color=black" alt="Demon" />
</a>&nbsp;
<a href="https://demon-connect.readthedocs.io">
<img alt="Static Badge" src="https://img.shields.io/badge/Docs-Demon-rgb?style=plastic&labelColor=black" alt="Docs">
</a>&nbsp;
<a href="LICENSE">
<img src="https://img.shields.io/github/license/anupammaurya6767/Demon_connect?style=plastic&labelColor=black&color=yellow" alt="License">
</a>&nbsp;
<img alt="GitHub forks" src="https://img.shields.io/github/forks/anupammaurya6767/Demon_connect?style=plastic&labelColor=black&color=blue">&nbsp;
<a href="https://chat.whatsapp.com/FGV7ef4d9tNGtfN8HDvbim">&nbsp;
<img src="https://badges.aleen42.com/src/whatsapp.svg?style=plastic&labelColor=black" alt="Whatsapp" /></a>
</p>

## Overview 👹

Welcome to **Demon Connect - WhatsApp API**, your powerful tool for unleashing the potential of WhatsApp in your applications. This API allows you to integrate WhatsApp messaging into your projects with ease.
**Demon Connect - WhatsApp API** is the ultimate tool for WhatsApp magic. 🧙‍♂️

<p align="center">
<img src="https://github.com/anupammaurya6767/Demon_connect/blob/main/sc1.jpeg" alt="Demon Connect Screenshot">
</p>
With this API, you can:

- Send and receive texts, images, and videos through WhatsApp
- Join WhatsApp group chats and interact with other users
- Customize the API to fit your project’s needs

**Demon Connect** is perfect for any app that wants to improve customer engagement, automate messaging, or just have fun with WhatsApp API.

Ready to start your adventure with **Demon Connect**? Join us today and unleash the power of WhatsApp in your apps!🔥

<br/>

Unleash the demon within as you explore the capabilities of this WhatsApp API. Transform your digital experience with the magic of **Demon Connect**.
## API Documentation 📚

This project provides a powerful API for interacting with WhatsApp Web. The API is implemented in the `whatsapp_api.py` module and is documented in detail in the [API Documentation]((Documentation/API.md)).

<br/>

## Features ✨

Expand All @@ -38,7 +56,9 @@ Unleash the demon within as you explore the capabilities of this WhatsApp API. T

🚀 **Group Messaging**: Engage with WhatsApp group chats via the API.

🪄 **Customization**: Customize and extend the API to suit your project's needs.
🔧 **Customization**: Customize and extend the API to suit your project's needs.

<br/>

## Usage 📱

Expand All @@ -51,10 +71,12 @@ Unleash the demon within as you explore the capabilities of this WhatsApp API. T
4. Explore advanced features and customization options.

<p align="center">
<img src="https://github.com/anupammaurya6767/Demon_connect/blob/main/sc2.jpeg" alt="Demon Connect Demo">
<img src="https://github.com/anupammaurya6767/Demon_connect/blob/main/assets/sc2.jpeg" alt="Demon Connect Demo">
</p>

## Installation 🧙‍♂️
<br/>

## Installation <a name="installation"></a>🧙‍♂️

1. Install Demon Connect via pip:
```bash
Expand Down Expand Up @@ -104,11 +126,30 @@ Unleash the demon within as you explore the capabilities of this WhatsApp API. T

```

<br/>

## Contributing 🌟
First off, thank you for considering contributing to our project! 🎉 We value all our contributors and we’re excited to see how you can make this project even better.

Before you start, we ask everyone to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). It’s important to us that we maintain a positive and inclusive environment for everyone in our community.

Next, take a moment to familiarize yourself with our [API Documentation](Documentation/API.md). Understanding the API is key to making meaningful contributions.

We also have a specific [workflow for contributions](WORKFLOW.md). This will give you an understanding of how we like to do things and make it easier for us to integrate your contributions.

Now, you’re ready to start contributing! Whether it’s enhancing features, fixing bugs, or improving documentation, every contribution counts. Remember, the best way to contribute is to start small. Find a task in the project that you feel comfortable with and start there.

If you ever get stuck or need help, don’t hesitate to reach out. We’re a community, and we’re here to help each other. You can join our community [WhatsApp group](https://chat.whatsapp.com/FGV7ef4d9tNGtfN8HDvbim). Happy coding! 😊

Contributions are welcome! Feel free to open issues and pull requests to enhance the API's power.
<br/>

## Security Policy 🔒

## Contributors
We take the security of our project seriously. For details on which versions of the project are currently being supported with security updates and how to report a vulnerability, please see our [Security Policy](SECURITY.md).

<br/>

## Contributors 🤝

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
Expand All @@ -122,12 +163,14 @@ Contributions are welcome! Feel free to open issues and pull requests to enhance
<img src="https://contrib.rocks/image?repo=anupammaurya6767/Demon_connect" />
</a>

<br/>

## License 📜

This project is licensed under the **WhatsApp API License**. See the [LICENSE](LICENSE) file for details.

<p align="center">
<img src="https://github.com/anupammaurya6767/Demon_connect/blob/main/image.png" alt="API License Seal">
<img src="https://github.com/anupammaurya6767/Demon_connect/blob/main/assets/image.png" alt="API License Seal">
</p>

Unlock the potential of WhatsApp in your applications with **Demon Connect - WhatsApp API**!
Binary file removed image.png
Binary file not shown.
Binary file removed main.png
Binary file not shown.
Binary file removed sc1.jpeg
Binary file not shown.
Binary file removed sc2.jpeg
Binary file not shown.

0 comments on commit 32ee122

Please sign in to comment.