Skip to content

Installation

Luca Dall'Acqua edited this page Jan 7, 2025 · 2 revisions

CVVSimpleAvgrage Installation Guide

Prerequisites

  • Python 3.6 or higher
  • Access to ClasseViva account

Step 1: Clone the Repository

First, clone the repository to your local machine:

git clone https://github.com/LucaCraft89/CVVSimpleAvgrage.git
cd CVVSimpleAvgrage

Step 2: Install Dependencies

Install the required Python packages:

pip install -r requirements.txt

Step 3: Run the Script

Run the script to sync your ClasseViva agenda with Google Calendar:

python CVVSimpleAvgrage.py

Step 4: See if it works

After running the script navigate to http://127.0.0.1:5000 in a web browser, input your Classeviva Student credentials and enjoy! 

Docker

Prerequisites

Step 5: Create and Run Container

Inside the repository directory do:

docker compose up -d

NOTE: Logs are not yet implemented

The web interface should not be available at port 5000 on all interfaces of the machine.

NOTE: On Ubuntu or if you have ufw installed you may need to run the following command to allow port 5000 thru the firewall.

ufw allow 5000

Troubleshooting

If you encounter any issues, please check the error messages and ensure that you didn't get any error during the process.