Data

Tools

Indexes

Applications

Experiments

Open Source Science

teachbooks

The source code and function of the package is documented at https://teachbooks.readthedocs.io/. Visit the dedicated manual page (https://teachbooks.io/manual/features/overview.html#teachbooks-python-package) to learn more about how this package is used in an educational context.

https://github.com/teachbooks/teachbooks

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

The source code and function of the package is documented at https://teachbooks.readthedocs.io/. Visit the dedicated manual page (https://teachbooks.io/manual/features/overview.html#teachbooks-python-package) to learn more about how this package is used in an educational context.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 1
  • Forks: 9
  • Open Issues: 34
  • Releases: 15
Created almost 2 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

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.

Owner

  • Name: PSOR Books
  • Login: TeachBooks
  • Kind: organization
  • Email: books-CEG@tudelft.nl
  • Location: Netherlands

Teachers’ Educational Assistance for interaCtive Hands-on Browser-based Online Open Knowledge for Students

Citation (CITATION.cff) 

cff-version: 1.2.0
title: TeachBooks Package
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - email: info@teachbooks.io
    name: 'TeachBooks Development Team'
    website: 'https://teachbooks.io/'
repository-code: 'https://github.com/TeachBooks/TeachBooks'
url: 'https://doi.org/10.5281/zenodo.15167392' 
repository-artifact: 'https://pypi.org/project/teachbooks/'
identifiers:
  - type: doi
    value: 10.5281/zenodo.15167392
    description: Latest released version of software
abstract: >-
  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, as CLI commands
  generally invoke jupyter-book commands internally (the
  jupyter-book package is not distributed by the teachbooks
  package).
institution:
    name: 'TeachBooks'
license: MIT
copyright: '© 2025 TeachBooks'
date-released: '2025-04-07'
languages:
    - en
contact:
  - email: info@teachbooks.io
    name: 'TeachBooks Development Team'
keywords:
    - TeachBooks
    - Package
    - Python
    - 'Jupyter Book'

GitHub Events

Total
  • Create event: 33
  • Issues event: 66
  • Release event: 9
  • Watch event: 5
  • Delete event: 29
  • Issue comment event: 231
  • Member event: 3
  • Push event: 121
  • Pull request review comment event: 35
  • Pull request review event: 67
  • Pull request event: 81
  • Fork event: 8
Last Year
  • Create event: 33
  • Issues event: 66
  • Release event: 9
  • Watch event: 5
  • Delete event: 29
  • Issue comment event: 231
  • Member event: 3
  • Push event: 121
  • Pull request review comment event: 35
  • Pull request review event: 67
  • Pull request event: 81
  • Fork event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 30
  • Total pull requests: 21
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 5 days
  • Total issue authors: 5
  • Total pull request authors: 5
  • Average comments per issue: 1.3
  • Average comments per pull request: 4.33
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 30
  • Pull requests: 21
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 5 days
  • Issue authors: 5
  • Pull request authors: 5
  • Average comments per issue: 1.3
  • Average comments per pull request: 4.33
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • rlanzafame (27)
  • Tom-van-Woudenberg (11)
  • BSchilperoort (6)
  • CasparJungbacker (6)
  • FreekPols (1)
  • douden (1)
Pull Request Authors
  • rlanzafame (16)
  • BSchilperoort (8)
  • Tom-van-Woudenberg (8)
  • junwon1022 (7)
  • CasparJungbacker (6)
  • DivyeshVora79909 (1)
  • zafar-hussain (1)
  • MarkMelotto (1)
  • ademhilmibozkurt (1)
  • FreekPols (1)
  • valanm22 (1)
Top Labels
Issue Labels
enhancement (6) bug (5) documentation (2) good first issue (2) waiting (1) refactor (1) help wanted (1) question (1)
Pull Request Labels
documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,642 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 13
  • Total maintainers: 1
pypi.org: teachbooks

TeachBooks wrapper around JupyterBooks

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1,642 Last month
Rankings
Dependent packages count: 9.6%
Average: 36.5%
Dependent repos count: 63.3%
Maintainers (1)
TeachBooks
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
  • jupyter-book ~= 1.0
  • matplotlib *
  • numpy *
  • pandas *
  • scipy *
.github/workflows/publish.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • actions/deploy-pages v4 composite
  • actions/setup-python v5 composite
  • actions/upload-pages-artifact v3 composite
.github/workflows/test.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v3 composite
tests/books/02/_ext/pybtexapastyle/setup.py pypi
tests/books/03/requirements.txt pypi
tests/test_external_content/testbook/book/_git/github.com_EXCITED-CO2_workshop_tutorial/v1.0.0/requirements.txt pypi
  • docutils ==0.17.1 test
  • jupyterbook-patches * test
  • sphinx-thebe * test
  • teachbooks * test
tests/test_external_content/testbook/book/_git/github.com_TeachBooks_HOS-workbook/main/requirements.txt pypi
  • docutils ==0.17.1 test
  • jupyterbook-patches * test
  • sphinx-thebe * test
  • teachbooks * test
tests/test_external_content/testbook/book/_git/gitlab.tudelft.nl_interactivetextbooks-citg_risk-and-reliability/main/requirements.txt pypi
  • citg-jb-stack * test
  • docutils ==0.17.1 test
  • jupyterbook_patches * test
  • jupyterquiz * test
  • openpyxl * test
  • pytest * test
  • seaborn * test
  • sphinx-thebe ==0.2.1000 test
  • sympy * test
tests/test_external_content/testbook/book/_git/gitlab.tudelft.nl_interactivetextbooks-citg_risk-and-reliability/v0.1/requirements.txt pypi
  • citg-jb-stack * test
  • docutils ==0.17.1 test
  • jupyterbook_patches * test
  • jupyterquiz * test
  • openpyxl * test
  • pytest * test
  • seaborn * test
  • sphinx-thebe ==0.2.1000 test
  • sympy * test
tests/test_external_content/testbook/requirements.txt pypi
  • docutils ==0.17.1 test
  • jupyterbook-patches * test
  • sphinx-image-inverter * test
  • sphinx-thebe * test
  • teachbooks * test
.github/workflows/links.yml actions
  • actions/checkout v4 composite
  • umbrelladocs/action-linkspector v1 composite
.github/workflows/lint.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite