Create 'getting started' notebook

tagbase / tagbase-server

tagbase-server is a data management web service for working with eTUFF and nc-eTAG files.

Apache License 2.0

7 stars 2 forks source link

Open lewismc opened 10 months ago

lewismc commented 10 months ago

This issue will provide a "getting started in 5 mins" for tagbase-server. Deliverables

Create a Jupyter notebook which uses testcontainers-python to launch the docker-compose stack and then interface with the REST API.
Use mybinder to launch everything via a one click. We can add a badge to the tagbase-server README.

lewismc commented 10 months ago

We should add the following CI to the notebook

ensure-clean-jupyter-notebooks; ensure that CI tests fail unless Jupyter notebooks have been appropriately linted prior to being pushed to the repository, and
nbmake; tests the notebook(s), runs them from top-to-bottom and fails if something goes wrong