Merge projects?

[timkpaine]

Any interest in merging projects?
https://github.com/timkpaine/jupyterlab_celltests

[amit1rrr]

I looked at jupyterlab_celltests briefly and couldn't figure out exactly what it does from the Readme. From what I understand, it's a Jupyter lab plugin that let's you write tests for each cell and stores them as cell metadata. There's probably some mocking support as well. Can you please explain the tool briefly? (how does one install it, what type of tests user can write etc).

Also, if you have a general idea on what functionalities would be useful to merge that would be great.

[timkpaine]

Yep, so basically there's a UI component for JupyterLab which lets you write tests for individual cells:

You can also configure some top-level assertions like >50% of cells have tests, there are no more than 10 lines in a given cell, etc, all of which are designed to further enforce the notion of notebooks as simple, slim, linearly-executed structures.

The on the backend, there are really 2 commands, lint and test.

Lint will basically check your top-level assertions (could be extended to include linting the python code using a linter, but notebook code is usually too different to get relevant results).

And test basically extracts your notebook python and cell tests into a standard python unittest and runs your cell tests and top level assertions with pytest.

Both lint and test results are usable from python and exposed in the jupyterlab UI.

[amit1rrr]

Thanks for explaining. Looks like a pretty useful tool. I would updated the Readme to convey this and how to get started.

About merging projects - these are both primarily in different formats for users to consume.
(JupyterLab UI vs cmdline). I don't see a path to really merge these as such and offering them both in a single tool is not ideal since we'll just be bloated with lot of options. I definitely want to support pytests in treon so maybe I will reach out to you for that. Here's the issue for it: #2