python-project-template icon indicating copy to clipboard operation
python-project-template copied to clipboard

Bundle dependency requirements with release

Open camposandro opened this issue 1 year ago • 5 comments

We might want to include in the source distribution a locked file of requirements (e.g. requirements.txt file with all the transitive dependencies that were proven to function at the time of publishing). This file is not intended for use by the common user but it is useful, e.g., when we rely on deployments on Kubernetes clusters (especially because when pods die&restart they tend to update dependencies automatically, which can cause mismatches in dependency versions).

This change was introduced for hipscat-import and could be bubbled up to the PPT.

camposandro avatar Aug 22 '24 18:08 camposandro

Should include running the unit tests just prior to publishing to PyPI.

drewoldag avatar Aug 23 '24 18:08 drewoldag

If we include the requirements.txt in the distribution, we should include clear instructions somewhere for users to see how we expect the requirements to be used.

drewoldag avatar Aug 23 '24 18:08 drewoldag

Should include running the unit tests just prior to publishing to PyPI.

Preferably on multiple platforms

hombit avatar Oct 25 '24 19:10 hombit

Also, it would be helpful to do the same, but with a conda environment file.

hombit avatar Oct 25 '24 19:10 hombit

Will wait to implement until we hear feedback from a group that has implemented this to decided if this is worth the effort.

drewoldag avatar Jan 24 '25 19:01 drewoldag