Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create 'getting started' notebook #298

Open
lewismc opened this issue Sep 14, 2023 · 1 comment
Open

Create 'getting started' notebook #298

lewismc opened this issue Sep 14, 2023 · 1 comment
Labels
dependencies Dependency Management issues deployment Deployment logic enhancement New feature or request good first issue Good for newcomers
Milestone
0.15.0

Comments

@lewismc
Copy link
Member

lewismc commented Sep 14, 2023

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

  1. Create a Jupyter notebook which uses testcontainers-python to launch the docker-compose stack and then interface with the REST API.
  2. Use mybinder to launch everything via a one click. We can add a badge to the tagbase-server README.
@lewismc lewismc added this to the 0.15.0 milestone Sep 14, 2023
@lewismc lewismc added enhancement New feature or request good first issue Good for newcomers dependencies Dependency Management issues deployment Deployment logic labels Sep 14, 2023
@lewismc lewismc changed the title Create notebook for "Getting started with tagbase-server in 5 mins" Create 'Getting started' notebook Sep 14, 2023
@lewismc lewismc changed the title Create 'Getting started' notebook Create 'getting started' notebook Sep 14, 2023
@lewismc lewismc mentioned this issue Sep 14, 2023
Closed
@lewismc
Copy link
Member Author

lewismc commented Sep 14, 2023

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

@lewismc lewismc mentioned this issue Sep 15, 2023
Closed
@lewismc lewismc mentioned this issue Sep 26, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
dependencies Dependency Management issues deployment Deployment logic enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
0.15.0
Development

No branches or pull requests
1 participant
@lewismc