| Name | nbtoolbelt JSON |
| Version |
2024.7.2
JSON |
| download |
| home_page | None |
| Summary | Tools to work with Jupyter notebooks |
| upload_time | 2024-10-01 09:34:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2017 - Eindhoven University of Technology, The Netherlands Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
jupyter notebooks
software tools
education
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# [nbtoolbelt](https://gitlab.tue.nl/jupyter-projects/nbtoolbelt) - Tools to Work with Jupyter Notebooks
* `validate`: validate notebooks
* `head`: show head or tail of notebooks
* `dump`: dump notebook info and source on terminal
* `stats`: summarize notebooks with statistics
* `view`: view notebook, including all embedded images, LaTeX, and HTML in a browser
* `cat`: concatenate multiple notebooks
* `clean`: clean notebooks by removing specified elements
* `run`: execute notebooks, with pre/post cleaning
* `split`: split notebooks into MarkDown, code, and raw
* `punch`: punch holes into notebooks and fill them (for creating exercises)
Available as library functions and as configurable command-line scripts.
## Installation
```bash
pip install nbtoolbelt
```
## Documentation
Documentation is available on
[Read the Docs](https://nbtoolbelt.readthedocs.io).
On the command line,
you can use the options `-h` or `--help`.
## Usage
On the command line:
```bash
nbtb [-h] [options] tool [options] nb.ipynb ...
```
As library: see documentation
## Testing
```bash
pip install nbtoolbelt[test]
```
`nbtoolbelt` comes with a set of automatic test cases for `pytest`.
## Developing
Some useful commands, and where to run them:
* In `nbtoolbelt/docs/`,
* clean build directory: `make clean`
* create html documentation tree: `make html`
* create pdf documentation: `make latexpdf`
* determine size of documentation: ```wc `find . -name '*.rst'` ```
* In `nbtoolbelt/test/`,
* run all test cases: `pytest .`
* In `nbtoolbelt/`,
* test package configuration: `python setup.py check -r -s`
* create source distribution and wheel: `python setup.py sdist bdist_wheel`
* In `nbtoolbelt/dist/`
* create digital signature: `gpg --detach-sign -a ...`
* upload to PyPI: `twine upload ...`
* In `nbtoolbelt/src/`,
* determine size of code: ```wc `find . -name '*.py'` ```
Steps to add a feature:
1. Add issue.
1. Design interface.
1. Add (failing) test cases in `nbtoolbelt/test/`.
1. Add documentation in `nbtoolbelt/docs/`.
1. Implement feature in `nbtoolbelt/src/nbtoolbelt/`.
1. Update `nbtoolbelt/src/nbtoolbelt/_version.py`.
1. Update `CHANGELOG.rst`.
1. Commit and push changes.
1. Close issue, indicating commit hash.
## License
Copyright (c) 2017 - Eindhoven University of Technology, The Netherlands
This software is made available under the terms of the [MIT License](LICENSE.txt).
## Resources
* [Python](https://python.org/): Python 3
* [Jupyter](https://jupyter.org/)
* [Jupyter notebook format](https://github.com/jupyter/nbformat/)
- [Documentation](https://nbformat.readthedocs.io/en/latest/format_description.html)
- Includes a format validator based on JSON schemas, such as
[nbformat.v4.schema.json](https://github.com/jupyter/nbformat/blob/master/nbformat/v4/nbformat.v4.schema.json)
* [JSON Schema](http://json-schema.org/)
* [./jq](https://stedolan.github.io/jq/):
a lightweight and flexible command-line JSON processor
* [Python 3 Patterns, Recipes and Idioms](https://python-3-patterns-idioms-test.readthedocs.io/en/latest/index.html)
Raw data
{
"_id": null,
"home_page": null,
"name": "nbtoolbelt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Jupyter notebooks, software tools, education",
"author": null,
"author_email": "\"Tom Verhoeff (Eindhoven Univesity of Technology)\" <T.Verhoeff@tue.nl>",
"download_url": "https://files.pythonhosted.org/packages/da/85/0f73d7ec06f2f0ed55045eb70196f2ab4f8eb9803f25684f859a84ec6f98/nbtoolbelt-2024.7.2.tar.gz",
"platform": null,
"description": "# [nbtoolbelt](https://gitlab.tue.nl/jupyter-projects/nbtoolbelt) - Tools to Work with Jupyter Notebooks\n\n* `validate`: validate notebooks\n* `head`: show head or tail of notebooks\n* `dump`: dump notebook info and source on terminal\n* `stats`: summarize notebooks with statistics\n* `view`: view notebook, including all embedded images, LaTeX, and HTML in a browser\n* `cat`: concatenate multiple notebooks\n* `clean`: clean notebooks by removing specified elements\n* `run`: execute notebooks, with pre/post cleaning\n* `split`: split notebooks into MarkDown, code, and raw\n* `punch`: punch holes into notebooks and fill them (for creating exercises)\n\nAvailable as library functions and as configurable command-line scripts.\n\n\n## Installation\n\n```bash\npip install nbtoolbelt\n```\n\n\n## Documentation\n\nDocumentation is available on\n[Read the Docs](https://nbtoolbelt.readthedocs.io).\n\nOn the command line,\nyou can use the options `-h` or `--help`.\n\n\n## Usage\n\nOn the command line:\n```bash\nnbtb [-h] [options] tool [options] nb.ipynb ...\n```\n\nAs library: see documentation\n\n\n## Testing\n\n```bash\npip install nbtoolbelt[test]\n```\n\n`nbtoolbelt` comes with a set of automatic test cases for `pytest`.\n\n\n## Developing\n\nSome useful commands, and where to run them:\n\n* In `nbtoolbelt/docs/`,\n * clean build directory: `make clean`\n * create html documentation tree: `make html`\n * create pdf documentation: `make latexpdf`\n * determine size of documentation: ```wc `find . -name '*.rst'` ```\n\n* In `nbtoolbelt/test/`,\n * run all test cases: `pytest .`\n\n* In `nbtoolbelt/`,\n * test package configuration: `python setup.py check -r -s`\n * create source distribution and wheel: `python setup.py sdist bdist_wheel`\n\n* In `nbtoolbelt/dist/`\n * create digital signature: `gpg --detach-sign -a ...`\n * upload to PyPI: `twine upload ...`\n\n* In `nbtoolbelt/src/`,\n * determine size of code: ```wc `find . -name '*.py'` ```\n\nSteps to add a feature:\n\n1. Add issue.\n\n1. Design interface.\n\n 1. Add (failing) test cases in `nbtoolbelt/test/`.\n\n 1. Add documentation in `nbtoolbelt/docs/`.\n\n1. Implement feature in `nbtoolbelt/src/nbtoolbelt/`.\n\n1. Update `nbtoolbelt/src/nbtoolbelt/_version.py`.\n\n1. Update `CHANGELOG.rst`.\n\n1. Commit and push changes.\n\n1. Close issue, indicating commit hash.\n\n\n## License\n\nCopyright (c) 2017 - Eindhoven University of Technology, The Netherlands\n\nThis software is made available under the terms of the [MIT License](LICENSE.txt).\n\n\n## Resources\n\n* [Python](https://python.org/): Python 3\n* [Jupyter](https://jupyter.org/)\n* [Jupyter notebook format](https://github.com/jupyter/nbformat/)\n - [Documentation](https://nbformat.readthedocs.io/en/latest/format_description.html)\n - Includes a format validator based on JSON schemas, such as\n [nbformat.v4.schema.json](https://github.com/jupyter/nbformat/blob/master/nbformat/v4/nbformat.v4.schema.json)\n* [JSON Schema](http://json-schema.org/)\n* [./jq](https://stedolan.github.io/jq/):\n a lightweight and flexible command-line JSON processor\n* [Python 3 Patterns, Recipes and Idioms](https://python-3-patterns-idioms-test.readthedocs.io/en/latest/index.html)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2017 - Eindhoven University of Technology, The Netherlands Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Tools to work with Jupyter notebooks",
"version": "2024.7.2",
"project_urls": {
"Changelog": "https://gitlab.tue.nl/jupyter-projects/nbtoolbelt/-/blob/master/CHANGELOG.rst",
"Documentation": "https://nbtoolbelt.readthedocs.io/",
"Homepage": "https://gitlab.tue.nl/jupyter-projects/nbtoolbelt",
"Issues": "https://gitlab.tue.nl/jupyter-projects/nbtoolbelt/-/issues",
"Source": "https://gitlab.tue.nl/jupyter-projects/nbtoolbelt/"
},
"split_keywords": [
"jupyter notebooks",
" software tools",
" education"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dffa6e71efbe59de623dafc8d19abcc8e9bc6415a0aaa3340d71392252dbf30",
"md5": "0cf62599b0c3e530823ba902b193bf86",
"sha256": "6a6528a4ad5920d721fdf724000e0fbe71f4df1f860efb3e142ccac2570582b9"
},
"downloads": -1,
"filename": "nbtoolbelt-2024.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cf62599b0c3e530823ba902b193bf86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 51392,
"upload_time": "2024-10-01T09:34:44",
"upload_time_iso_8601": "2024-10-01T09:34:44.470778Z",
"url": "https://files.pythonhosted.org/packages/6d/ff/a6e71efbe59de623dafc8d19abcc8e9bc6415a0aaa3340d71392252dbf30/nbtoolbelt-2024.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da850f73d7ec06f2f0ed55045eb70196f2ab4f8eb9803f25684f859a84ec6f98",
"md5": "9553b961638a6e06fc4f61ecd119d340",
"sha256": "f2b931e5e998e114ca2f01d92b6afe17692b60f043dc54cddd07fcb7e5e23074"
},
"downloads": -1,
"filename": "nbtoolbelt-2024.7.2.tar.gz",
"has_sig": false,
"md5_digest": "9553b961638a6e06fc4f61ecd119d340",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 38362,
"upload_time": "2024-10-01T09:34:45",
"upload_time_iso_8601": "2024-10-01T09:34:45.884170Z",
"url": "https://files.pythonhosted.org/packages/da/85/0f73d7ec06f2f0ed55045eb70196f2ab4f8eb9803f25684f859a84ec6f98/nbtoolbelt-2024.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 09:34:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nbtoolbelt"
}
