planesections icon indicating copy to clipboard operation
planesections copied to clipboard
verified publisher icon cslotboom

cmp - organize for editable install

Open claudioperez opened this issue 1 year ago • 2 comments

This is a great project! I am currently working with PEER at UC Berkeley to develop a new optimized Python interface for OpenSees that eliminates some of the existing vulnerabilities to global state corruption. I've started working on integrating this new interface into your package, but first, I needed to move the files into a subdirectory of src in order to run a local editable install with pip. Do you have a different installation method that would work for editable installs? If not, this pull request may ease future collaborations. The changes are:

  • move everything under src/ to a subdirectory named src/planesections/
  • add a minimal pyproject.toml file to allow editable install (pip install -e .)

claudioperez avatar Mar 20 '24 20:03 claudioperez

Hey, thanks for your PR! I'm really interested to see what changes are coming down the pipeline with the OpenSees interface! I tried to make a system that allowed users to get type-hints and docstrings for opensees functions, but gave up on it..

To answer your question, I haven't used editable installs before, but I don't see any issue with implementing these changes. I do want to do a bit of research before pulling anything into the main package - once I do that I'll follow up with any other changes I think should happen.

cslotboom avatar Mar 22 '24 07:03 cslotboom

Thanks for considering the change! Take your time looking into it, and let me know if you have any better ideas! I'm just looking for a way to install locally. In case it helps, this is a nice resource for laying out Python packages: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/

claudioperez avatar Mar 30 '24 23:03 claudioperez

Hey, made a few changes to the pyproject.toml to match my old setup.py. After review, this works more easily than what I've been doing - in the next few days I'm going to confirm I can successfully upload to pypi under the new scheme then merge this in. Thanks for the suggestion!

cslotboom avatar Apr 27 '24 23:04 cslotboom

Hey @claudioperez, I've confirmed I can still upload to PYPI with this setup, and am satisfied nothing is broken. This should be ready to merge, can you confirm everything is good on your end before I make the jump?

cslotboom avatar May 01 '24 08:05 cslotboom

Yeah, everything looks great!

claudioperez avatar May 02 '24 16:05 claudioperez