Skip to content

itsmeved24/Promptly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Promptly 🌅

Send fun, warm "Custom Prompted" messages with beautiful images to your loved ones via WhatsApp—automatically, every day.

✨ Features

  • 📸 Fetch Beautiful Images: Random high-quality images from Unsplash
  • 💬 Automated Messaging: Send scheduled messages via WhatsApp
  • 📝 Comprehensive Logging: Track events and errors
  • ⚙️ Full Customization: Personalize messages, timing, and images

🛠️ Tech Stack

  • Python: Core application logic
  • Unsplash API: For fetching beautiful images
  • PyWhatKit: WhatsApp automation
  • Schedule: Task scheduling

🚀 Getting Started

Prerequisites

  • Python 3.6+
  • WhatsApp Web access
  • Unsplash API key

Installation

You can either install the package from PyPI or clone the repository:

Option 1: Install from PyPI (for users)

pip install promptly-whatsapp

Option 2: Clone the Repository

  1. Clone the repository:
git clone https://github.com/itsmeved24/Promptly.git
cd Promptly
  1. Install dependencies:
pip install -r requirements.txt
  1. Create a .env file:
PHONE_NUMBER=+911234567890
UNSPLASH_API_KEY=your_unsplash_api_key_here
  1. Run the application:
python main.py

⚙️ Customization

  • Message Text: Edit message templates in main.py
  • Image Categories: Modify keywords in image_fetcher.py
  • Scheduling: Adjust timing with schedule.every().day.at("HH:MM") in main.py
  • Custom Images: Add personal images to images/ directory

📋 Project Structure

.
├── promptly/                # Main package directory
│   ├── __init__.py          # Package initialization
│   ├── image_fetcher.py     # Image fetching module
│   └── main.py              # Core application file
├── dist/                    # Distribution files
├── .env                     # Environment variables
├── README.md                # Documentation
├── requirements.txt         # Dependencies
└── setup.py                 # Package configuration

📊 Logging

The application creates detailed logs (image_fetcher.log) that include:

  • Timestamps for each operation
  • Success/failure status
  • Image URLs and query terms
  • Detailed error information
  • Debug information

Made with ❤️ by Vedank

📜 License

This project is licensed under the MIT License.

About

Let Promptly handle your regular greetings.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages