OCHRE
OCHRE copied to clipboard
NREL
Declare verisons of dependencies
- Requirements should be versioned, ideally using compatible versioning.
-
Python version should be restricted too, to not pick up development versions.
- For instance, due to a numba restriction, Python 3.12 is not supported by OCHRE.
Thanks for adding this. We'll make sure we get to it before the next release.
We have another dependency issue too. OCHRE only works with pandas>=1.4 and <=2.0.3. We'll make sure the latest pandas is supported in the next release
I think this is partially addressed in #120. I restricted python to <3.12. We fixed the pandas issue, so no need to restrict that. We haven't fully tested compatibility for other dependencies, but I think we can update those as we find issues.
If ochre is ready to be used by people outside of your dev team, please add versioning requirements to the dependencies! You never know when, for instance, Pandas will release version 3.0.0 and break something ochre depends on. Since you support both Pandas 1 & 2, you can't use compatible-release versioning, you'd have to do something like Pandas >=1.4, < 3.0.
Might also be nice to remind yourself with a comment that numba is the reason you can't support python 3.12, so a new version of numba would allow you to relax that requirement.
@vtnate do you mind reviewing this commit? Any recommended changes? https://github.com/NREL/OCHRE/pull/120/commits/6d920d8f954e3c5fa57c37dc69e3f06e21d4a157
I'm testing with python 12 too, I'll add that back in if there's still a compatibility issue
@vtnate do you mind reviewing this commit? Any recommended changes? 6d920d8
@mnblonsky I like it!
- Why only version some dependencies?
- When projects are still in the
0.y.zversion phase, changes to minor (.y) versions often include breaking changes. You may be safer setting those dependencies to0.y.0instead of0.y.- I recently got burned by this on another project so it's fresh in my mind 😆