ni / ni/datastore-python

Make dedicated pyproject.toml for the example notebooks

Open
#92 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tech debt
Dominant language
Python
Stars
2
Forks
0
Avg merge
1d 14h
Merged PRs (30d)
6

Description

Currently, examples\notebooks depend on the venv created with the root package. It would be cleaner if we had a separate pyproject.toml to use for each notebook. This would remove dependencies in the root pyproject.toml that are only needed for notebooks (if any). It would also remove all of the dev dependencies from the notebooks' venv(s) so those would be cleaner.

It may be possible to have a single venv for all of the notebooks. However, this would mean it's pyproject.toml would show all the deps for all notebooks. Consider / discuss this when fixing this issue.

AB#3744853

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the root pyproject.toml and inspecting the dependency needs under examples/notebooks. Decide whether each notebook needs its own pyproject.toml or whether one shared environment is suitable. Done means the notebook environment no longer relies on the root package's development dependencies and any notebook-only dependencies are removed from the root configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.