Skip to main content

Runtime helpers + build tooling for jupytext-percent teaching notebooks: test mode, terminal image display, and student/teacher/colab generation

Project description

jupytext-notebook-helper

Small runtime helpers for teaching notebooks written in the jupytext percent format and built with jupytext-filter (student/teacher/colab versions).

Extracted from master_mind.teaching.utils so it can be reused across courses without pulling in the whole master-mind framework.

from jupytext_notebook_helper import *   # test_mode, skip_plots, print_header, is_notebook
  • test_mode / skip_plots — driven by the TESTING_MODE env var (off | on | full).
  • print_header(title) — formatted header when run as a script; jupytext-filter turns it into a markdown header in notebooks.
  • On script execution (e.g. make check), matplotlib.pyplot.show() is patched to render figures inline in the terminal via imgcat.

Intended to be imported from a teacher-only cell: students never see the test-mode machinery, and the package is not required on Colab.

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

jupytext_notebook_helper-0.1.0.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

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

jupytext_notebook_helper-0.1.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file jupytext_notebook_helper-0.1.0.tar.gz.

File metadata

  • Download URL: jupytext_notebook_helper-0.1.0.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for jupytext_notebook_helper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bf70fcfe46a33a9c28c5f77df6045b450ee576d793924e2dbe7387bdce0968e7
MD5 156104217f4975d15062c458f521d62b
BLAKE2b-256 6da5016b44a32d0f38cc393caa0a77a95cc66066a4b486ece31ebbeca4dfe41e

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupytext_notebook_helper-0.1.0.tar.gz:

Publisher: python-publish.yml on bpiwowar/jupytext-notebook-helper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jupytext_notebook_helper-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupytext_notebook_helper-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d898035130bccc1bd38c330006c29096831c067f244275b18e73f9d87d0f0e68
MD5 29f42f966ffd5c9e07d117ccb22370cd
BLAKE2b-256 7b036d2e9b1f3b0e170610ca57fca12b511bc4a9bcc72a93ee5e1a86fec76b69

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupytext_notebook_helper-0.1.0-py3-none-any.whl:

Publisher: python-publish.yml on bpiwowar/jupytext-notebook-helper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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