Skip to content

AndreMPCosta/padel-checker-pub

Repository files navigation

Padel Checker

python-3.6-3.7-3.8

A tool which its main goal is to notify if a court becomes available during X schedule in a certain area.


Core Features:

  • Fetch Available Slots: pick a date and a time and fetch all the available slots where you can book a court.

img.png

  • Create Watchers: create a watcher for a certain period and get notified via e-mail when a new slot pops up.

  • Define your favorite clubs: this way, you only get notified in courts of interest.

Requirements

Docker: 20.10 and later

Docker Compose: 1.29.2 and later

MailJet Account to send emails to users.

Optional

(to be able to use MailJet to send notifications by email, as customize MongoDB and RabbitMQ)

Python: 3.6 and later (tested against 3.6, 3.7, 3.8 and 3.9)

Typer (to run start script to customize everything)

Installation

git clone https://github.com/AndreMPCosta/padel-checker-pub.git

After:

cd padel-checker-pub

Optional Step


Run:

pip install typer

Configure your env variables with:

python start.py

img3.png


It is advised for you to create a new folder and use your own .env files, based on the sample_environment folder (that's what the optional step does for you).

For example, you can create a folder named environment and put the .env files there. After, just change the docker.env to point to that folder, ex:

ENVIRONMENT_FOLDER=environment

And finally:

docker-compose --env-file docker.env up

If everything went smoothly, you should have these following containers:

img2.png

Usage

To check flower dashboard navigate to:

http://localhost:5555/

There you can watch the fetching task being executed every minute (These tasks are being coordinated by Celery).

To access the docs for the endpoints:

http://localhost:8000/docs

Notes: This repository is intended to be used on Portugal, it is using Aircourts API to fetch data.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published