updates for new infrastructure

This commit is contained in:
adam j hartz 2025-07-11 00:09:27 -04:00
commit 580ce8c33a
Signed by: hz
GPG key ID: B63A0A59F5C82493
4 changed files with 40 additions and 59 deletions

View file

@ -1,25 +0,0 @@
syntax: glob
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# Debian package files
debian/gradesoop
debian/.debhelper
debian/gradesoop.substvars
debian/files
.pybuild

32
README
View file

@ -1,32 +0,0 @@
# gradesoop: grading of printed exams within catsoop
## installation
install prereqs and the gradesoop package:
$ sudo apt install poppler-utils libzbar-dev mercurial
$ pip install hg+https://catsoop.org/hg/gradesoop
this will install the gradesoop command, which is the entry point for all of
the pdf processing stuff. run the following to get started:
$ gradesoop --help
## usage
all of the subcommands have a --help flag that shows usage, arguments, and
options. here they are, roughly in the order they're needed:
* "gradesoop add-qrs" for adding qr codes to exams
* "gradesoop parse-scans" for reading and organizing raw scan data
* "gradesoop separate" for generating per-student pdfs from scan data
* "gradesoop setup-catsoop-course" for adding the web interface to a course (NOT YET IMPLEMENTED)
## acknowledgements
the first version of gradesoop was started in spring 2016 and was developed
primarily by a collection of dedicated 6.01 ta's: Rodrigo Toste Gomes, Gustavo
Goretkin, Jeremy Kaplan, Kade Phillips, and Jeremy Wright. much of the code
has been rewritten, but the current version is resting comfortably on the
shoulders of their work.

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# gradesoop: grading of printed exams within catsoop
[![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page)
## installation
install prereqs and the gradesoop package:
```
$ sudo apt install poppler-utils libzbar-dev git
$ pip install git+https://catsoop.org/git/catsoop/gradesoop
```
this will install the `gradesoop` command, which is the entry point for all of
the pdf processing stuff. run the following to get started:
```
$ gradesoop --help
```
## usage
all of the subcommands have a `--help` flag that shows usage, arguments, and
options. here they are, roughly in the order they're needed:
* `gradesoop add-qrs` for adding qr codes to exams
* `gradesoop parse-scans` for reading and organizing raw scan data
* `gradesoop separate` for generating per-student pdfs from scan data
* `gradesoop setup-catsoop-course` for adding the web interface to a course (NOT YET IMPLEMENTED)
## acknowledgements
the first version of gradesoop was started in spring 2016 and was developed
primarily by a collection of dedicated 6.01 ta's: Rodrigo Toste Gomes, Gustavo
Goretkin, Jeremy Kaplan, Kade Phillips, and Jeremy Wright. much of the code
has been rewritten, but the current version is resting comfortably on the
shoulders of their work.

View file

@ -13,7 +13,7 @@ def main():
with open(os.path.join(os.path.dirname(__file__), "requirements.txt"), "r") as f:
requirements = f.read().split("\n")
with open(os.path.join(os.path.dirname(__file__), "README"), "r") as f:
with open(os.path.join(os.path.dirname(__file__), "README.md"), "r") as f:
readme = f.read()
try:
@ -51,7 +51,7 @@ def main():
license="AGPLv3+",
description="gradesoop: grading of printed exams within catsoop",
long_description=readme,
long_description_content_type="text/plain",
long_description_content_type="text/markdown",
include_package_data=True,
entry_points={"console_scripts": ["gradesoop = gradesoop.__main__:main"]},
install_requires=requirements,