submit — Homework submission tools

Small Python tools to prepare and submit homework assignments:

• Online submission: uploads a (optionally encrypted) bundle as a private GitHub Gist via the GitHub CLI (gh).
• Offline submission: creates a ZIP file you can upload manually.

Implementation:

• Online entrypoint: submit.submit:run (function: submit.submit.run)
• Offline implementation: submit.submit_offline.main

Workspace files

• Configuration template/example: submit.cfg
• Example payload files: testdatei1.txt, testdatei2.txt
• Package metadata / entrypoints: pyproject.toml
• Included public key: src/submit/gpg/htw.asc (defaults in submit.gpg.public_key_name and submit.gpg.public_key_file)

Requirements

• Python >= 3.10 (see .python-version)
• Online submission:
  • curl installed
  • gh installed (the github cli)
  • authenticated (gh auth login) or run submit --authorize or provide a token from github via the environment variable GH_TOKEN
• Encryption:
  • gpg installed

The online tool checks required CLIs in submit.submit.check_tools and installs/verifies the default public key via submit.submit.check_default_gpg_key.

Installation

This project defines a console script entrypoint in pyproject.toml:

• submit → submit.submit:run

Install into your environment using your preferred tool (pip/uv/etc.), then run submit from the directory that contains your assignment’s submit.cfg.

Configuration (submit.cfg)

Place a submit.cfg in the directory you want to submit from.

Minimal example (same structure as submit.cfg):

[Uebung]
aufgabe = 99

[Abgeben]
datei1 = testdatei1.txt
datei2 = testdatei2.txt

Notes:

• [Uebung].aufgabe must be an integer $0 \leq \text{aufgabe} \leq 99$.
• Under [Abgeben], all files must exist, otherwise submission aborts (see submit.submit.check_local_config / submit.submit_offline.checklocalconfig).

Usage

Online (default)

From the directory containing submit.cfg:

submit

This will:

1. copy the files listed in [Abgeben] to a temp directory (see submit.submit.copy_files)
2. encrypt them by default (see submit.submit.encrypt)
3. create a private gist upload (see submit.submit.submit)

Offline (create ZIP for manual upload)

This mode should only be used when promped by the lecture.

From the directory containing submit.cfg:

submit --offline

This will:

1. copy the files listed in [Abgeben] to a temp directory (see submit.submit_offline.copyfiles)
2. (by default) encrypt them (see submit.submit_offline.encrypt)
3. create a ZIP in your current directory (see submit.submit_offline.submit)

Disable encryption (offline only):

submit --offline --no-encryption