Skip to content

Latest commit

 

History

History
76 lines (55 loc) · 2.62 KB

Readme.md

File metadata and controls

76 lines (55 loc) · 2.62 KB
Raw
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

         ━━━━━━━━━━━━━
          ┏┓┏┓┳┳┓┏┓┓┏
          ┃ ┃┃┃┃┃┃┃┗┫
          ┗┛┗┛┛ ┗┣┛┗┛
         ━━━━━━━━━━━━━

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Competition organization tool
for freediving competitions.

Copyright 2023 - Arno Mayrhofer

Licensed under the GNU AGPL

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Authors:

- Arno Mayrhofer

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Compy

Compy is a competition organization tool for freediving competition. Its current features are:

  • Parse AIDA International Style Excel files
  • Switch between CMAS and AIDA competitions (different countdown, different result view without points for CMAS)
  • Uploading of sponsor image for output on PDFs
  • Output of results, lane lists and start lists via PDF
  • Possibility to select athletes for special ranking (e.g. newcommer)
  • List of breaks for each athlete on each day
  • Automated countdown

Future features can be seen in the TODO file.

Prerequisites

  • git
  • python3
    • openpyxl
    • pandas
    • country_converter
    • flask

Installing the software

  • Navigate with a terminal (powershell on Windows) to the folder where you want to create the compy folder in
  • Execute git clone https://github.com/Azrael3000/Compy.git
  • Switch to the new folder: cd Compy
  • Set up the environmen: cp .env_sample .env
  • For deployments you MUST edit the .env file and provide a new secret. A new one can be generated e.g. by running python3 -c "import secrets; print(secrets.token_hex())"
  • Start a virtual environment and install required packages:
    • Linux: source venv/bin/activate && pip install -r requirements.txt
  • Set up the database and run the server: python3 compy.py --init_db

Running the software

  • Download the repository
  • Navigate with a terminal to the folder containing compy.py
  • Start a virtual environment:
    • Linux: source venv/bin/activate
  • Execute compy.py
    • Linux: python3 compy.py
    • Windows: python3.exe compy.py
  • Navigate your browser to localhost:5000

Want to help?

As is clearly visible, this tool is lacking a nice user interface. If you want to help making one, please write me at hydros@TLD. (TLD=posteo.net). Other help (writing the backend, documentation, testing) is also welcome.