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

Restructured code and other small changes #275

Merged
merged 4 commits into from
Jan 12, 2024
Merged

Conversation

ChiCheng45
Copy link
Collaborator

@ChiCheng45 ChiCheng45 commented Jan 12, 2024

Description of work
Restructured the code so that it follows the src-layout as shown in https://setuptools.pypa.io/en/latest/userguide/package_discovery.html which is more standard than the previous layout. Previously I was having some issues getting the editable build to work, the restructuring fixes this. Also included some changes which improve things a bit which includes:

  • updated gitignore to ignore: distribution/packaging files and directories, generated pyd extensions, pycharm related stuff
  • moved package data to the manifest.in
  • changed script to entry-points so that they can be run as if they were executables
  • updated the github wheels.yml to use python -m build since python setup.py bdist_wheel is deprecated https://packaging.python.org/en/latest/discussions/setup-py-deprecated/

Fixes
Fixes MDANSE and MDANSE_GUI installation using editable mode

To test
Run pip install -e . in the MDANSE and MDANSE_GUI and checked mdanse.exe and mdanse_gui.exe run without crashing. Built wheels with python -m build and installed them in a different environment to check building is done correctly and checked mdanse.exe and mdanse_gui.exe again.

… is not required during development. Also added mdanse script entry points so that the script can be run more easily from the command line. Updated gitignore.
Copy link
Collaborator

@MBartkowiakSTFC MBartkowiakSTFC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work! Works on my computer, and should be a big improvement on Windows machines.

@MBartkowiakSTFC MBartkowiakSTFC merged commit 2dbf415 into protos Jan 12, 2024
42 checks passed
@ChiCheng45 ChiCheng45 deleted the chi/restructuring branch January 12, 2024 18:14
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.

2 participants