No description
Find a file
2026-07-30 14:16:24 -04:00
img Fixed file structure 2026-07-28 11:25:27 -04:00
src Prepared project for other nerds to look at 2026-07-30 13:55:51 -04:00
.env.template Prepared project for other nerds to look at 2026-07-30 13:55:51 -04:00
.gitignore Did some refactoring, bug fixing, and improved usability 2026-07-30 13:19:43 -04:00
example_object.json Got the baseline for Jira requests established and determined project structure 2026-07-20 21:24:01 -04:00
README.md Update README.md 2026-07-30 14:16:24 -04:00
requirements.txt Prepared project for other nerds to look at 2026-07-30 13:55:51 -04:00

GIRESD Label Maker

Written by Nolan Casey, 2026

Installation

Currently, the label maker is written entirely in Python as a command line application. Both of these things may change in the future, so make sure to check these instructions between updates to make sure they haven't changed

Linux

Install the prerequisites: Debian/Ubuntu/Mint:

sudo apt install python3 python3-venv

Run these commands:

git clone https://forgejo.nolancasey.click/nolan/GIRESD-label-maker.git
cd GIRESD-label-maker
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.template .env

From here, fill .env with your relevant variables

Windows

I haven't done any testing here yet, and I don't remember how to do everything off the top of my head, so I will summarize the process for now and finish these instructions another time.

  1. Install Python 3
  2. Clone the repository somewhere
  3. Create a virtual environment inside of the cloned directory
  4. Activate the virtual environment
  5. Run pip install -r requirements.txt
  6. Copy .env.template to .env and fill it with your relevant variables

Usage

  1. Before running, make sure that you have activated the virtual environment. On Linux, this is done by running source venv/bin/activate from the root directory of the project.
  2. Run main.py with python3 src/main.py from the root directory of the project.
  3. When running the command, any additional command line arguments will be treated as csv files. In order to import, they must have one column headed with 'serial' (not case sensitive) in the first row. All entries below that header will be entered as serial numbers. Alternatively, these csv files can be specified after running the program.