Skip to content

Commit 3926d96

Browse files
authored
📝 Position nbproject (#264)
* 📝 Position nbproject * 💄 Polish * 💄 Polish more * 💄 Polish
1 parent 1460347 commit 3926d96

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,19 @@
33
[![pypi](https://img.shields.io/pypi/v/nbproject?color=blue&label=pypi%20package)](https://pypi.org/project/nbproject)
44
[![doi](https://img.shields.io/badge/doi-10.56528%2Fnbp-lightgrey)](https://doi.org/10.56528/nbp)
55

6-
# nbproject: Manage Jupyter notebooks
6+
# nbproject: Light-weight Jupyter notebook tracker
77

8-
Track & publish notebooks with their metadata, dependencies, and consecutiveness.
8+
Track & publish notebooks with their metadata, dependencies & integrity.
99

10-
Why? Read the [blog post](https://lamin.ai/blog/2022/nbproject).
10+
💡 Consider [lamindb.track()](https://lamin.ai/docs/lamindb.track) instead of nbproject for these improvements:
11+
12+
- consistently track data sources across notebooks, pipelines & apps
13+
- full provenance for datasets that you pull and push from notebooks
14+
- manage notebook copying & integrate with Google Colab
15+
16+
Like `nbproject`, `lamindb` is open-source. `nbproject` will mostly be maintained as a backend for `lamindb`.
17+
18+
---
1119

1220
Supported editors & platforms:
1321

@@ -31,11 +39,11 @@ Get started:
3139
```
3240
import nbproject
3341
34-
nbproject.header() # Tracks notebook, displays metadata.
42+
nbproject.header() # Tracks notebook, displays metadata
3543
3644
# do things
3745
38-
nbproject.publish() # Checks consecutiveness
46+
nbproject.publish() # Checks consecutiveness, bumps version
3947
```
4048

4149
More: Read the [docs](https://lamin.ai/docs/nbproject).

0 commit comments

Comments
 (0)