Skip to main content

With this tool, one can define pieces of a notebook that belong to teachers and should not be exposed to students.

Project description

nbprune

typical use case is, a teacher writes a notebook, with solution(s) to a problem that students must solve
so this means 2 versions, one for the teacher(s) with the solutions, and one for the students
this tool defines annotations that the teacher can use to define the parts that will be automatically removed by the tool

keywords

here are the recognized keywords

tag meaning
prune-cell remove this cell from the output
prune-begin remove this cell and the ones below from the output
prune-end remove this cell, but resume insertion on the next cell
prune-begin-next (*) keep this cell from the output, and start pruning at the next one
prune-end-previous (*) stop pruning, and insert the current cell
prune-line (*) remove just that one line from the output
prune-line-begin (**) remove that line and the following ones
prune-line-end (**) remove that line but the following ones will show up

NOTES

  • (*) because prune-begin-next and prune-end-previous appear in a cell that is visible, the whole line containing the tag is removed from the output, so it is probably best to keep these tags on a separate line
  • (**) prune-line variants of course are not relevant, and are ignored, if set in the cell's metadata tags

line format

the tool will consider a tag is present in a cell if any line in the cell contains one of the above keywords, with the beginning of the line containing only # and spaces or tabs

so for exemple

line match
prune-cell yes
# prune-cell yes
# # prune-cell yes
some code prune-cell no

cell metadata

the tags can also be set in the cell's metadata as well (except for prune-line) ; something like this

{
  "tags": [
    "prune-cell"
  ]
}

examples

so that these 2 scenarios are equivalent

cell tag preserved
1 y
2 prune-cell n
3 y
4 y
5 prune-begin-next y
6 n
7 n
8 n
9 prune-end-previous y
10 y

or


cell tag preserved
1 y
2 prune-cell n
3 y
4 y
5 y
6 prune-begin n
7 n
8 prune-end n
9 y
10 y

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

nbprune-0.3.2.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

nbprune-0.3.2-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file nbprune-0.3.2.tar.gz.

File metadata

  • Download URL: nbprune-0.3.2.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for nbprune-0.3.2.tar.gz
Algorithm Hash digest
SHA256 1d1cea1b9f12f380bf165d523d8d3a904e0c5e450111617c8aa62b44a5cf3034
MD5 b79e8c67222930e4deb46a955883ff4a
BLAKE2b-256 783777f589bc29b6cf52ddd3b9b778320886c3f66b351e34dbd1e9d2db233e5f

See more details on using hashes here.

File details

Details for the file nbprune-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: nbprune-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for nbprune-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e086416ce08fcd751760a3f4d82e4afaf0231c6f6855b167350b652d8929f2dc
MD5 499ff1023ba4ef359da5c6f75712c140
BLAKE2b-256 206d2751f8153021c1e8792c4aafe610c835e8eabc6ee3a3bc30e58e3995f880

See more details on using hashes here.

Supported by

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