Reorganize to prep for applying scientific-python cookie#16
Conversation
Issue OpenwaterHealth#5 * Remove the top level __init__ from the repo, which was wrongly making the top level appear to be a python package. * Move pyfus to src/pyfus. This way when you are working in the repo directory python will not try import things from the current directory. The should be no confusion about where imports are coming from. See https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/ * Remove [tool.setuptools.packages.find] from the pyproject.toml. It is not needed -- I believe setuptools already finds pacakages by looking for the __init__.py 's
Issue OpenwaterHealth#5 Files updated using `end-of-file-fixer`, `mixed-line-ending`, `trailing-whitespace`, `blacken-docs` and `mirrors-prettier` pre-commit hooks
Issue OpenwaterHealth#5 Sphinx is configured to look for this directory, this change helps supress a sphinx warning
Issue OpenwaterHealth#5 This helps to avoid confusion with unit tests Unit tests will be brought in soon and we don't want the test_notebooks to look like they are part of that
ebrahimebrahim
force-pushed
the
reorganize_to_prep_for_issue_5
branch
from
c301599 to
8a2b299
Compare
peterhollender
left a comment
peterhollender
left a comment
There was a problem hiding this comment.
Looks good. I see that it's just moving/renaming/adjusting line endings.
There was a problem hiding this comment.
@ebrahimebrahim do you know why this change and water.py are showing up as whole new files instead of renames+ modification like the others?
There was a problem hiding this comment.
Hmm I'm not certain but it might be due to the length of the file. The file is short, so because 9f23b5b had to both rename (move) the file and edit it (changing pyfus to openlifu) it was treated by git as a large proportion of the file changing. When git sees a rename and a large proportion of changes I think it treats that as a delete-and-add rather than as a move
|
(Disabling status checks to merge this before bringing in #17 which actually introduces status checks. Will re-enable status checks after merging.) |
2 participants
Re-organize the repo in order to prepare for the PR #17 that will resolve #5 by applying the scientific-python cookiecutter to add CI.
src/subdirectorypyfustosrc/pyfus. This way when you are working in the repo directory python will not try import things from the current directory. The should be no confusion about where imports are coming from.__init__.pyspyfus-->openlifuend-of-file-fixer,mixed-line-ending,trailing-whitespace,blacken-docs, andprettierpre-commit hooks. These are the easy non-sweeping style fixes that will make the linting pass once we introduce it. For the other style fixes, they are going to be configured to be ignored by the linter and we can add those rules back in over time in separate PRs.docs/_static/.gitkeep: Sphinx is configured to look for this directory, this change helps suppress a sphinx warningto look like they are part of that.