Skip to content

Khalilolgod/sanjesh-toefl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TOEFL Voucher Availability Notifier

This project periodically checks a specified website for TOEFL voucher availability and sends notifications via Bale Messenger, an Iranian messaging platform. The script is designed to bypass internet censorship by using Bale for notifications, ensuring you are alerted in real-time when vouchers become available.

The project is containerized with Docker, making it easy to deploy and run across various environments.


Features

  • Periodic Website Monitoring: Automates checking a website for specific content updates.
  • Bale Messenger Notifications: Alerts are sent directly to your Bale account to bypass internet restrictions.
  • Environment Configurations: Easy setup with .env for sensitive information like tokens and chat IDs.
  • Dockerized Deployment: Portable and isolated environment for hassle-free execution.

Prerequisites

Before running the project, ensure you have the following installed:

  1. Docker: Get Docker
  2. Python 3.10: For local development (if not using Docker).
  3. Bale Bot Token and Chat ID: Obtain these by creating a bot on Bale Messenger.

Project Structure

.
├── Dockerfile               # Docker configuration for containerized deployment
├── requirements.txt         # Python dependencies
├── scraper.py               # Main script to check website and send notifications
├── .env                     # Environment variables (not included in the repo)
└── README.md                # Project documentation

Setup Instructions

Step 1: Clone the Repository

Clone this repository to your local machine:

git clone https://github.com/Khalilolgod/sanjesh-toefl.git
cd sanjesh-toefl

Step 2: Configure Environment Variables

Create a .env file in the project directory with the following content:

BOT_TOKEN=<your_bale_bot_token>
CHAT_ID=<your_bale_chat_id>

Replace <your_bale_bot_token> and <your_bale_chat_id> with your Bale bot's token and your chat ID, respectively.


Step 3: Build the Docker Image

Build the Docker image using the provided Dockerfile:

docker build -t toefl-voucher-notifier .

Step 4: Run the Docker Container

Run the container with the following command:

docker run toefl-voucher-notifier

The script will now start monitoring the website and send notifications to Bale if vouchers become available.


Local Development (Optional)

If you prefer to run the script without Docker, follow these steps:

  1. Install Dependencies:

    Ensure Python 3.10 is installed. Then, install the required dependencies:

    pip install -r requirements.txt
  2. Run the Script:

    Execute the script locally:

    python scraper.py

Customization

  • Monitoring Interval: Adjust the frequency of checks by modifying the appropriate line in scraper.py.
  • Target Website: Change the URL and search logic in scraper.py to monitor different websites.

Contributions

Contributions are welcome! Feel free to submit issues or pull requests to improve the project.


Enjoy hassle-free monitoring and notification for TOEFL voucher availability! 😊

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published