https://github.com/mathiazom/rezervo

🏋🏿‍♂️ Automatic booking of group classes
https://github.com/mathiazom/rezervo

3t automation fastapi fsc sit slack-bot workout

Last synced: 4 days ago
JSON representation

🏋🏿‍♂️ Automatic booking of group classes

• Host: GitHub
• URL: https://github.com/mathiazom/rezervo
• Owner: mathiazom
• Created: 2021-08-20T14:45:31.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-26T22:35:30.000Z (24 days ago)
• Last Synced: 2024-10-28T01:18:14.721Z (23 days ago)
• Topics: 3t, automation, fastapi, fsc, sit, slack-bot, workout
• Language: Python
• Homepage:
• Size: 1.89 MB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🏋🏿‍♂️ rezervo

[![rezervo](https://img.shields.io/badge/ghcr.io-mathiazom%2Frezervo-blue?logo=docker)](https://github.com/users/mathiazom/packages/container/package/rezervo)

Automatic booking of group classes

### 🧩 Chains



   

      

   

   

      

   

   

      

   

   

      

   



#### ⚙️ Providers



   

      

   

   

      

   



### 🧑‍💻 Development

#### 🐍 Setup Python environment

1. Ensure Python 3.10+ is installed

2. Install dependencies using Poetry (install from https://python-poetry.org/docs/#installation)

    ```shell

    poetry install

    ```

3. In the [`rezervo`](rezervo) directory, define `.env` and `config.json` based on [`.env.template`](rezervo/.env.template) and [`config.template.json`](rezervo/config.template.json). This includes defining Auth0 tenant details, credentials for Slack notifications and app-wide booking preferences.

   

   

      📳 Web Push variables

   

      ##### Web Push variables

      Web push requires a VAPID key pair. This can be generated with the following command using `openssl`:

      ```shell

      openssl ecparam -name prime256v1 -genkey -noout -out vapid_keypair.pem

      ```

      The private key can then be encoded as base64 and added to the `.env` file as `WEB_PUSH_PRIVATE_KEY`:

      ```shell

      openssl ec -in ./vapid_keypair.pem -outform DER|tail -c +8|head -c 32|base64|tr -d '=' |tr '/+' '_-' >> vapid_private.txt

      ```

      Similarly, the public key can be encoded as base64 and included in the client application receiving the notifications:

      ```shell

      openssl ec -in ./vapid_keypair.pem -pubout -outform DER|tail -c 65|base64|tr -d '=' |tr '/+' '_-'|tr -d '\n' >> vapid_public.txt

      ```

   

#### 🐋 Run with Docker

1. Make sure you have defined `.env` and `config.json` as described above

2. With [docker](https://docs.docker.com/get-docker/) and [docker compose](https://docs.docker.com/compose/) installed, run

    ```shell

    docker compose -f docker/docker-compose.dev.yml up -d --build

    ```

3. Within the container, explore available cli commands

    ```shell

    rezervo --help

    ```

#### 🧹 Format and lint

```shell

poe fix

```

#### 🔌 Support new chain

Add your own chain by adding it to `ACTIVE_CHAINS` in [`rezervo/chains/active.py`](rezervo/chains/active.py).

### 🚀 Deployment

A template for a production deployment is given in [`docker-compose.template.yml`](docker/docker-compose.template.yml), which uses the most recent [`rezervo` Docker image](https://github.com/users/mathiazom/packages/container/package/rezervo).