README.adoc

School Timetabling (Python)

Assign lessons to timeslots and rooms to produce a better schedule for teachers and students.

• Prerequisites

• Run the application

• Test the application

Prerequisites

1. Install Python 3.11+

2. Install JDK 17+, for example with Sdkman:

   $ sdk install java

Run the application

1. Git clone the timefold-quickstarts repo and navigate to this directory:

   $ git clone https://github.com/TimefoldAI/timefold-quickstarts.git
   ...
   $ cd timefold-quickstarts/python/school-timetabling

2. Create a virtual environment

   $ python -m venv .venv

3. Activate the virtual environment

   $ . .venv/bin/activate

4. Install the application

   $ pip install -e .

5. Run the application

   $ run-app

6. Visit http://localhost:8080 in your browser.

7. Click on the Solve button.

Test the application

1. Run tests

   $ pytest

More information

Visit timefold.ai.