Skip to content

src folder and pyproject packaging#108

Closed
shimwell wants to merge 2 commits into
openmc-dev:developfrom
shimwell:update_package_layout
Closed

src folder and pyproject packaging#108
shimwell wants to merge 2 commits into
openmc-dev:developfrom
shimwell:update_package_layout

Conversation

@shimwell

@shimwell shimwell commented Jan 19, 2023

Copy link
Copy Markdown
Member

Just seeing if the package could be updated to follow the latest python packaging recommendations https://packaging.python.org/en/latest/tutorials/packaging-projects/

  • use of a src folder - helps avoid local import using folder name instead of installed package
  • use of pyproject.toml instead of depreciated setup.py
  • use of setuptools_scm to get version number

3 benefits of src folder layout are detailed at the bottom of this page

@shimwell

shimwell commented Feb 10, 2023

Copy link
Copy Markdown
Member Author

this PR has some major merge conflicts since #110 was merged so I shall close it for now. If there is any interest in moving to a src folder layout for the package, updating the setup to use pyproject.toml or automatic the versioning with setuptools_scm give me a nudge and I can do this PR or aspects of it again

@shimwell shimwell closed this Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant