Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/treebeardtech/nbmake-action
GitHub Action for testing notebooks
https://github.com/treebeardtech/nbmake-action
action notebook test
Last synced: about 1 month ago
JSON representation
GitHub Action for testing notebooks
- Host: GitHub
- URL: https://github.com/treebeardtech/nbmake-action
- Owner: treebeardtech
- License: apache-2.0
- Archived: true
- Created: 2020-02-06T15:49:32.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-21T08:52:43.000Z (about 3 years ago)
- Last Synced: 2024-09-25T09:22:29.328Z (about 1 month ago)
- Topics: action, notebook, test
- Language: TypeScript
- Homepage:
- Size: 3.89 MB
- Stars: 152
- Watchers: 9
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- my-awesome-github-stars - treebeardtech/nbmake-action - GitHub Action for testing notebooks (TypeScript)
- awesome-jupyter-resources - GitHub
- awesome-starred - treebeardtech/nbmake-action - GitHub Action for testing notebooks (others)
README
**⚠️ Please use [nbmake](https://github.com/treebeardtech/nbmake) instead**
# nbmake-action
(repo renamed from 'treebeard').
**What?** A GitHub Action for testing notebooks, runs them from top-to-bottom
**Why?** To raise the quality of scientific material through better automation
**Who is this for?** Scientists/Developers who have written docs in notebooks and want to CI test them after every commit
## Functionality
Tests notebooks using [nbmake](https://github.com/treebeardtech/nbmake) via pytest.
**Note: If you have some experience setting up GitHub actions already you will probably prefer the flexibility of using the `nbmake` pip package directly.**
## Quick Start
```yaml
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: "treebeardtech/[email protected]"
with:
path: "./examples"
path-output: .
notebooks: |
nb1.ipynb
'sub dir/*.ipynb'
```
See [action.yml](action.yml) for the parameters you can pass to this action, and see [unit tests](.github/workflows/action_unit_test.yml) and [integ tests](.github/workflows/action_integration_test.yml) for example invocations.
## Developing
### Install local package
```
npm install
```
### Run checks and build
```
npm run all
```
## See Also
- [nbmake](https://github.com/treebeardtech/nbmake)
- [jupyter book](https://github.com/executablebooks/jupyter-book)
- [Guide to python dependency management choices](https://towardsdatascience.com/devops-for-data-science-making-your-python-project-reproducible-f55646e110fa)