neuromatch-course-kit

The nma-kit command line for Neuromatch courses written in MyST Markdown. It is one half of the Neuromatch course kit; the other half is the MyST plugin on npm, @neuromatch/course-kit. Both ship under the same version.

Courses usually don't install this by hand: the reusable GitHub workflows in the kit repository do. To use it locally:

uv venv && uv pip install -r requirements.txt "neuromatch-course-kit==0.1.*"
uv run nma-kit check
uv run myst start

Requires Python 3.10 or newer. Run every command from the course root (the folder with myst.yml).

Commands

Exit codes: 0 ok, 1 content problems or a failed publish, 2 usage or configuration errors.

Settings

Read from myst.yml: project.github gives the repository, and the optional top-level nma: block holds the rest.

nma:
  paths:
    tutorials: tutorials          # where the .md pages live
  notebooks:
    branch: notebooks-branch      # where generated notebooks are published
  feedback:                       # required if any page uses {nma-feedback}
    url: https://...
    project: ...
    user_key: ...

Values in nma: must be plain strings in one level of sections.

Versions

The kit is on 0.x. A breaking change bumps the minor version, so ==0.1.* only receives compatible fixes. The CLI and the npm plugin always share a version number, and prepare-site pins the plugin URL to the CLI's own version.

Source, docs and release process: https://github.com/neuromatch/course-kit.

BSD-3-Clause.