Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datarootsio/databooks
A CLI tool to reduce the friction between data scientists by reducing git conflicts removing notebook metadata and gracefully resolving git conflicts.
https://github.com/datarootsio/databooks
cli git helper-tool jupyter-notebook pydantic rich typer
Last synced: 23 minutes ago
JSON representation
A CLI tool to reduce the friction between data scientists by reducing git conflicts removing notebook metadata and gracefully resolving git conflicts.
- Host: GitHub
- URL: https://github.com/datarootsio/databooks
- Owner: datarootsio
- License: mit
- Created: 2021-12-10T20:47:05.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T21:04:43.000Z (over 1 year ago)
- Last Synced: 2025-01-15T02:26:45.279Z (7 days ago)
- Topics: cli, git, helper-tool, jupyter-notebook, pydantic, rich, typer
- Language: Python
- Homepage: https://databooks.dev/
- Size: 79.8 MB
- Stars: 111
- Watchers: 9
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
`databooks` is a package to ease the collaboration between data scientists using
[Jupyter notebooks](https://jupyter.org/), by reducing the number of git conflicts between
different notebooks and resolution of git conflicts when encountered.
The key features include:
- CLI tool
- Clear notebook metadata
- Resolve git conflicts
- Simple to use
- Simple API for using modelling and comparing notebooks using [Pydantic](https://pydantic-docs.helpmanual.io/)
## Requirements
`databooks` is built on top of:
- Python 3.7+
- [Typer](https://typer.tiangolo.com/)
- [Rich](https://rich.readthedocs.io/en/latest/)
- [Pydantic](https://pydantic-docs.helpmanual.io/)
- [GitPython](https://gitpython.readthedocs.io/en/stable/tutorial.html)
- [Tomli](https://github.com/hukkin/tomli)
## Installation
```
pip install databooks
```
## Usage
### Clear metadata
Simply specify the paths for notebook files to remove metadata. By doing so, we can
already avoid many of the conflicts.
```console
$ databooks meta [OPTIONS] PATHS...
```
### Fix git conflicts for notebooks
Specify the paths for notebook files with conflicts to be fixed. Then, `databooks` finds
the source notebooks that caused the conflicts and compares them (so no JSON manipulation!)
```console
$ databooks fix [OPTIONS] PATHS...
```
### Assert notebook metadata
Specify paths of notebooks to be checked, an expression or recipe of what you'd like to
enforce. `databooks` will run your checks and raise errors if any notebook does not
comply with the desired metadata values. This advanced feature allows users to enforce
cell tags, sequential cell execution, maximum number of cells, among many other things!
Check out our [docs](https://databooks.dev/latest/usage/overview/#databooks-assert) for more!
```console
$ databooks assert [OPTIONS] PATHS...
```
### Show rich notebook
Instead of launching Jupyter and opening the browser to inspect notebooks, have a quick
look at them in the terminal. All you need is to specify the path(s) of the notebook(s).
```console
$ databooks show [OPTIONS] PATHS...
```
### Show rich notebook diffs
Similar to git diff, but for notebooks! Show a rich diff of the notebooks in the
terminal. Works for comparing git index with the current working directory, comparing
branches or blobs.
```console
$ databooks diff [OPTIONS] [REF_BASE] [REF_REMOTE] [PATHS]...
```
## License
This project is licensed under the terms of the MIT license.