Skip to main content

TeachBooks Package: Jupyter Book Wrapper

This Python package is primarily a wrapper around the Jupyter Book package and is designed to facilitate usage of the platform in educational contexts. In this case "wrapper" refers to the CLI usage: CLI commands generally invoke jupyter-book commands internally; the jupyter-book package is not distributed within the teachbooks package.

The source code and function of the package is documented at teachbooks.readthedocs.io. Visit the TeachBooks website and dedicated Manual page to learn more about how this package is used in an educational context.

Updates and Improvements

Expect frequent updates to the package as patches and minor releases until further notice. We expect to release v1.0.0 in Spring, 2025. Update the package in your local environment using using pip install --upgrade teachbooks.

Contributions are ideally made via a fork and pull request to the (default) develop branch (see the project Documentation for detailed instructions).

Documentation Website

The documentation for this package is built using Sphinx and @pradyunsg's Furo; use the Furo documentation as a reference when updating the documentation site.

The Read the Docs website teachbooks.readthedocs.io maintains documentation for each tagged release beginning with v0.2.0. The documentation website is also deployed from GitHub Pages from the stable branch and can be accessed at teachbooks.io/TeachBooks/. This should remain identical to the "latest" (default) Read the Docs documentation page as long as the most recent tagged release is on branch stable.

Acknowledgements

This package received financial support from the Civil Engineering and Geosciences faculty at Delft University of Technology in the Netherlands via Education Innovation Projects, MUDE and direct financial support of Jupyter Book applications in education by the CEG faculty. The project also received funding from the TU Delft Library at the end of 2024. Bart Schilperoort of the Netherlands eScience Center implemented the external contents module and also provided critical advice on the journey to v1.0.0.

The first version of this package was created and released by Caspar Jungbacker in Spring, 2024 and has since been primarily maintained by a variety of TeachBooks contributors.

Download files

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

Source Distribution

teachbooks-0.2.5.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

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

teachbooks-0.2.5-py3-none-any.whl (45.3 kB view details)

Uploaded Python 3

File details

Details for the file teachbooks-0.2.5.tar.gz.

File metadata

  • Download URL: teachbooks-0.2.5.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for teachbooks-0.2.5.tar.gz
Algorithm Hash digest
SHA256 e98e44f7d3a63f46d812e949e34999c62e4185304d7648b7ac34a58c289d6c3b
MD5 286cbb732788bffef65cb38d05dc3966
BLAKE2b-256 cb27d3d68e838774449368a4704757cc980d5152ad27aafc7eaabbb3d42622f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for teachbooks-0.2.5.tar.gz:

Publisher: publish.yml on TeachBooks/TeachBooks

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

File details

Details for the file teachbooks-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: teachbooks-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 45.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for teachbooks-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 285edf1f75275463a970b25c4bf312ff77f834304ff5c21417bcf6fb9de17235
MD5 2303ce9dd985e90262eb03947e810d16
BLAKE2b-256 ace7992d469644baa4408e2d0be36e07aa727fe0a2dea40dc9c150ca10c8c5ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for teachbooks-0.2.5-py3-none-any.whl:

Publisher: publish.yml on TeachBooks/TeachBooks

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

Release history Release notifications | RSS feed

This release

0.2.5 This release

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

0.0.11

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

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