Skip to main content

Assess your students' work with all of the delight and none of the tedium

Project description

Markten

Assess your students' work with all of the delight and none of the tedium.

Markten is an automation framework aimed at reducing the pain of marking student assignments in bulk. By writing a simple recipe, you can define the steps you take to mark an assignment, which can be anything from fetching submissions, compiling their code, viewing their codebase in an IDE, or running a test suite. It's all done with simple readable Python, with enough power under the hood to make even the most annoying workflows trivial.

Installing

$ pip install markten
...
Successfully installed markten-1.0.0

Or to install in an independent environment, you can use pipx or uv:

$ pipx install markten
  installed package markten 1.0.0, installed using Python 3.12.6
  These apps are now globally available
    - markten
done!  🌟 ✨
$ uv tool install markten
Resolved 10 packages in 2ms
Installed 10 packages in 11ms
 + aiosqlite==0.21.0
 + click==8.2.1
 + humanize==4.12.3
 + markdown-it-py==3.0.0
 + markten==1.0.0
 + mdurl==0.1.2
 + platformdirs==4.3.8
 + pygments==2.19.1
 + rich==13.9.4
 + typing-extensions==4.14.0
Installed 1 executable: markten

Running recipes

You can execute the recipe directly, like you would any Python script:

$ python my_recipe.py
...

You can also use the markten executable if you want to keep markten's dependencies in an isolated environment. The Python script you provide as an argument is executed within that environment.

$ markten my_recipe.py
...

How it works

Define your recipe parameters. For example, this recipe takes in git repo names from stdin.

from markten import Recipe, ActionSession, parameters, actions

marker = Recipe("Clone COMP1010 repos")

marker.parameter("repo", parameters.stdin("Repo name"))

Write simple marking recipes by defining simple functions for each step.

# Functions can take arbitrary parameters, as long as those parameters were
# defined earlier in the script.
# Using the `Recipe.step` decorator allows us to register an action as a step
# to the recipe.
@marker.step
async def setup(action: ActionSession, repo: str):
    """Set up marking environment"""
    # Clone the given git repo to a temporary directory
    directory = await actions.git.clone(action, f"git@github.com:COMP1010UNSW/{repo}.git")
    return {
        "directory": directory,
    }

The values returned by your previous steps can be used in later steps, just by giving the function parameters the same name.

@marker.step
def open_code(action: ActionSession, directory: Path):
    """Open the cloned git repo in VS Code"""
    return actions.editor.vs_code(action, directory)

Then run the recipe. It'll run for every permutation of your parameters, making it easy to mark in bulk.

marker.run()

For more examples, see the examples directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markten-1.3.4.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

markten-1.3.4-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file markten-1.3.4.tar.gz.

File metadata

  • Download URL: markten-1.3.4.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for markten-1.3.4.tar.gz
Algorithm Hash digest
SHA256 449fd4be1bb5adf2680c1f770ed566a3ec37094340be5edd3c7d31aad83d25e8
MD5 08b72e80b63f459eaa8905bb745ad072
BLAKE2b-256 228bf74d2bd428a56e7f2e48e436b3eb5b1331227d65192167682c53e3873a29

See more details on using hashes here.

File details

Details for the file markten-1.3.4-py3-none-any.whl.

File metadata

  • Download URL: markten-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 38.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for markten-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1363b6e6e7d17354ed51a01b31d18571ee010c9cff75918cbf84507c47919861
MD5 50a524d98949168cb3644c9697abb4b6
BLAKE2b-256 b3f0c95aacdb6bf022eda1dbe91360187555944d40781c8607d9347710d3ab1b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page