Time Dispatcher

Table of contents

• Prerequisites
• Installation
• Run the app
  • Production
  • Development
• Updating

---

Time Dispatcher is a QoL tool to help you track, analyze and allocate your time spent on various projects. Here is a list of the main features available :

• Import tasks, projects and time imputations from CSV (compatible with Super Productivity)
• Create parents to group multiple projects
• Track your clock-ins / -outs and/or remote work
• Mark each parent as either productive or not, i.e. whether its projects take a share of the "clocked" time
• Automatically compute the time that should be reported as spent on each productive parent (for example to input in SageX)
• View your monthly working times in a nice table or in a summarized form on the dashboard

Prerequisites

• Python 3+

Installation

1. Clone the repository

   git clone https://git.kb28.ch/HEL/TimeDispatcher.git
   

2. Go inside the project directory

   cd TimeDispatcher/
   

3. Install the Python requirements

   pip install -r requirements.txt
   

4. Apply the database migrations

   python manage.py migrate
   

5. Set the appropriate settings in the .env file:
   1. Copy .env.template to .env

      cp .env.template .env
      

   2. Fill in the settings
      • DJANGO_SECRET_KEY: The secret key used by Django. This is a long random string. For example, it can be generated using Python with

        import secrets
        secrets.token_urlsafe(64)
        

      • DJANGO_ENV: Current environment, either prod or dev
      • DJANGO_HOSTS: Comma-separated list of allowed hosts used by Django

Run the app

Production

1. Start the Uvicorn server

   python main.py
   

2. Open the app in your browser

Development

1. Start the Django server

   python manage.py runserver
   

2. Open the app in your browser

Updating

(Before updating to a new version, it is recommended to back up the database file, i.e. db.sqlite3)

To update to a new version:

1. Download the new sources
   • from the release page
   • or pull the new version with git
2. Run the database migrations:

   python manage.py migrate