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-line (*) remove just that one line from the output
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

NOTES

  • (*) prune-line of course is not relevant, and ignored, if set in the cell's metadata tags
  • (**) 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 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.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

nbprune-0.3.1-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nbprune-0.3.1.tar.gz
Algorithm Hash digest
SHA256 a5b0ab099747e4847f568233525266591e63cb29433afa0ac4cbe696f07bc5fa
MD5 44f830665359403987df9fbf0542e3d6
BLAKE2b-256 53638af8162e0f91357683f4dd6ef6f8650543f60a36aa0148fb898dd4480e15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbprune-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for nbprune-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 399fae64b0c5d5f6586118bd8fc01cf7e7684433368ad0bcd106225101282b36
MD5 7e2a975c4c6b6802c99e3b619b79c5b9
BLAKE2b-256 4926bcdf1de6e30ca4dd2f597d969cc031c668d3d2f2056dc70ca4444dab611c

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