Recent Releases of teachbooks
teachbooks - v0.2.2
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.
0.2.2 - 2025-07-15
Fixed
- Nested
external:entries in the table of content are now parsed correctly (#108). LICENSE.txtandLICENSE.rstfiles are now also checked when cloning external content (#110).
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.2.1...v0.2.2
- Python
Published by BSchilperoort 11 months ago
teachbooks - v0.2.1
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.
0.2.1 - 2025-05-02
Added
- admonitions which will automatically be added at the top of external content pages (#96).
- Automatically generated API docs to the package documentation (#89).
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.2.0...v0.2.1
- Python
Published by BSchilperoort about 1 year ago
teachbooks - v0.2.0
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.
0.2.0 - 2025-04-07
This release introduces an exciting new feature: automatically including external content in your book!
Added
- A new way to include external content in your books. You can now refer to other books published on github/gitlab. For more info see the documentation page and the dedicated TeachBooks Manual page (#59).
- Documentation for the entire package is provided by via Read the Docs: teachbooks.readthedocs.io
- A license is now provided (MIT)
- A waiver is added clarifying that TeachBooks is the copyright holder, allowing contributions from the community to be more straightforward
- added Linkspector to verify URL's in documentation
- A changelog
What's Changed
- Next release: v0.1.0 by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/54
- Add support for refering to external content on github and gitlab by @BSchilperoort in https://github.com/TeachBooks/TeachBooks/pull/59
- Documentation updates by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/53
- Configure ReadTheDocs integration by @BSchilperoort in https://github.com/TeachBooks/TeachBooks/pull/80
- A few adjustments to external content for v0.2.0 by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/73
- add Linkspector test on PR's by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/84
- External content adjustments by @BSchilperoort in https://github.com/TeachBooks/TeachBooks/pull/81
- v0.2.0 final adjustments by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/87
- Next release v0.2.0 by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/82
New Contributors
- @BSchilperoort made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/59
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.1.0...v0.2.0
- Python
Published by rlanzafame about 1 year ago
teachbooks - v0.2.0b1
This (soft) release allows authors to easily include pages from other ("external") git repositories in their book.
Usage is extremely simple to use, all you have to do is use external: <URL> and replace URL with the desired file. You can read more about it in the Manual here.
It is a soft release to ensure that the new feature does not affect existing books using our deploy-book workflow. To use this feature make sure you install the specific version in your Python environment using pip install teachbooks==0.2.0b1.
Happy book-writing!
What's Changed
- Add support for refering to external content on github and gitlab by @BSchilperoort in https://github.com/TeachBooks/TeachBooks/pull/59
- Documentation updates by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/53
New Contributors
- @BSchilperoort made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/59
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.1.0...v0.2.0b1
- Python
Published by rlanzafame about 1 year ago
teachbooks - v.0.1.0
Significant improvements to the teachbooks serve command, plus the ability to include APA referencing style have warranted our first minor release!
Major update to teachbooks serve:
- default behavior is to serve ./book/_build/html/; if not available default to ./
- will serve user-specified path via teachbooks serve path <path>
- Improved messaging when using serve (implementation of different verbosity levels is present, but VERY rough and not complete/consistent)
- All messages added directly to serve CLI and Server class except in CLI build, a function check_status is added to check server status after build is executed and prints a message accordingly
- hard-coded key directories to support above operations in __init__.py; specifically, define default book context (./book/_build/html) and server working dir (./.teachbooks/server)
- added simple tests for cli serve, serve path <path> and serve stop (more tests needed!)
- temporary directory ./book/.teachbooks/server/ changed to ./.teachbooks/server/. This may also happen for the release directory (and all future usage of .teachbooks/ in general), but that will be implemented later.
Work has been going on in parallel to easily add APA style citations and references (see TeachBooks manual). To support this, a temporary fix is added that copies ./book/_ext to ./book/.teachbooks/release/_ext/ so that APA style does not cause an error when using --release build ("release" mode), which caused the deploy-book-workflow to fail when a branch is included in BRANCHES_TO_PREPROCESS.
Other changes not directly related to the serve or APA features:
- cleaned out a few more remnants of "publish" by replacing with "release"
- add pytest tests for teachbooks build using the test books ./tests/books/**/ (more needed!). This mirrors the setup of Jupyter Book.
- added --version option to CLI
- updated README to better describe package (taking into account the Manual page will no longer use the README)
- updated pyproject.toml to include GH repo as homepage and release v0.1.0
What's Changed
- Rename temp directory by @valanm22 in https://github.com/TeachBooks/TeachBooks/pull/43
- Add version option by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/45
- temp dir changed to .teachbooks/release closes #42 by @zafar-hussain in https://github.com/TeachBooks/TeachBooks/pull/47
- improve server feature by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/46
- check_server + message end of build by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/51
- Enable APA in release mode [TEMPORARY FEATURE] by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/52
- Next release: v0.1.0 by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/44
New Contributors
- @valanm22 made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/43
- @zafar-hussain made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/47
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.11...v0.1.0
- Python
Published by rlanzafame over 1 year ago
teachbooks - v0.0.11
Added file size to ouput
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.10...v0.0.11
- Python
Published by Tom-van-Woudenberg over 1 year ago
teachbooks - v0.0.9
What's Changed
- Change release.py to publish.py by @junwon1022 in https://github.com/TeachBooks/TeachBooks/pull/37
- Housekeeping by @rlanzafame in https://github.com/TeachBooks/TeachBooks/pull/34
New Contributors
- @rlanzafame made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/34
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.8...v0.0.9
- Python
Published by Tom-van-Woudenberg over 1 year ago
teachbooks - v0.0.8
Added error message for depriciation
What's Changed
- Release command outputs an stderr message by @junwon1022 in https://github.com/TeachBooks/TeachBooks/pull/32
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.7...v0.0.8
- Python
Published by Tom-van-Woudenberg over 1 year ago
teachbooks - v0.0.7
Added feature to pass all jupyterbook options to the jupyter-book command
What's Changed
- Jupyterbook options by @junwon1022 in https://github.com/TeachBooks/TeachBooks/pull/28
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.6...v0.0.7
- Python
Published by Tom-van-Woudenberg over 1 year ago
teachbooks - v0.0.6
This release does not add any new features, but it should result in a new PyPI package, the first since v0.0.3 (v0.0.4 and v0.0.5 were not released on PyPI because we did not update the toml file when tagging and creating release on GitHub).
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.5...v0.0.6
- Python
Published by rlanzafame over 1 year ago
teachbooks - v0.0.5
What's Changed
Added clean CLI option that does two things:
1. check if a Teachbooks server is running and shut it down
2. run jupyter book clean <dir>
This avoids the annoying error that happens when running jupyter book clean book if a teachbooks server was active.
- Teachbooks clean by @junwon1022 in https://github.com/TeachBooks/TeachBooks/pull/24
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.4...v0.0.5
- Python
Published by rlanzafame over 1 year ago
teachbooks - Version 4
Replaced --publish by --release
What's Changed
- Added release option by @junwon1022 in https://github.com/TeachBooks/TeachBooks/pull/23
- Update README.md by @Tom-van-Woudenberg in https://github.com/TeachBooks/TeachBooks/pull/25
- more docs update by @Tom-van-Woudenberg in https://github.com/TeachBooks/TeachBooks/pull/26
New Contributors
- @junwon1022 made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/23
- @Tom-van-Woudenberg made their first contribution in https://github.com/TeachBooks/TeachBooks/pull/25
Full Changelog: https://github.com/TeachBooks/TeachBooks/compare/v0.0.3...v0.0.4
- Python
Published by Tom-van-Woudenberg over 1 year ago
teachbooks - Version 0.0.3
Rename the hidden working directory to .teachbooks.
- Python
Published by CasparJungbacker over 1 year ago
teachbooks - Version 0.0.2
Adds server functionality and testing infrastructure.
- Python
Published by CasparJungbacker about 2 years ago