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.

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

feat: streamline notebooks #71

Merged
merged 9 commits into from
Aug 14, 2024
Merged

feat: streamline notebooks #71

merged 9 commits into from
Aug 14, 2024

Conversation

ESKYoung
Copy link
Owner

Summary

Clean up the notebook directory by renaming it to exploratory, and:

  • organising exploratory tasks
  • creating a exploratory Python environment constrained by the underlying Poetry environment
  • adding example exploratory packages, tests, and documentation.

It's not ideal to have both Poetry, and pip working in the same repository. Nor is it ideal that the exploratory environment modifies the underlying Python environment used by Poetry, but at least the Poetry configuration is unaffected.

Checklists

I/we (contributor) confirm that the code, and analyses in this Pull Request (developments) meets the following requirements:

  • code runs
  • developments are ethical, and secure
  • contributor has made proportionate checks that the developments are correct
  • minimum usable documentation is written in plain English in the docs folder
  • all pre-commit hooks pass
  • test suite passes
  • code coverage is maintained, or increased

Additional comments

Also drop the complete exclusion of everything except Jupyter
notebooks, since exploratory work could also include packages, and
scripts.
Allows for better separation of exploratory tasks.
This is constrained by the project's Poetry environment without
complicating the `pyproject.toml` file, and increasing the complexity of
Poetry dependency resolution.

It also minimises dependency conflicts between the Poetry, and
exploratory environments, smoothing the path to production.
Also show how to import the package from inside the Jupyter notebook.

Editable package installation is not used here in case users need to
remove them later on, which may complicate things.
@ESKYoung ESKYoung added the enhancement New feature or request label Aug 14, 2024
@ESKYoung ESKYoung self-assigned this Aug 14, 2024
@ESKYoung ESKYoung merged commit 78216a2 into 2.x.x Aug 14, 2024
10 checks passed
@ESKYoung ESKYoung deleted the streamline-notebooks branch August 14, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant