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

Declare verisons of dependencies #100

Open
vtnate opened this issue Jan 11, 2024 · 8 comments
Open

Declare verisons of dependencies #100

vtnate opened this issue Jan 11, 2024 · 8 comments
Assignees

Comments

@vtnate
Copy link

vtnate commented Jan 11, 2024

  • 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.
@jmaguire1 jmaguire1 self-assigned this Jan 11, 2024
@mnblonsky
Copy link
Collaborator

Thanks for adding this. We'll make sure we get to it before the next release.

@mnblonsky mnblonsky mentioned this issue Feb 14, 2024
3 tasks
@mnblonsky
Copy link
Collaborator

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

@mnblonsky
Copy link
Collaborator

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.

@vtnate
Copy link
Author

vtnate commented Apr 30, 2024

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.

@mnblonsky
Copy link
Collaborator

@vtnate do you mind reviewing this commit? Any recommended changes?
6d920d8

@mnblonsky
Copy link
Collaborator

I'm testing with python 12 too, I'll add that back in if there's still a compatibility issue

@vtnate
Copy link
Author

vtnate commented May 2, 2024

@vtnate do you mind reviewing this commit? Any recommended changes? 6d920d8

@mnblonsky I like it!

  1. Why only version some dependencies?
  2. When projects are still in the 0.y.z version phase, changes to minor (.y) versions often include breaking changes. You may be safer setting those dependencies to 0.y.0 instead of 0.y.
    • I recently got burned by this on another project so it's fresh in my mind 😆

@mnblonsky
Copy link
Collaborator

Addressed both of those, and Python 3.12 works. Thanks for the review!

jmaguire1 added a commit that referenced this issue May 16, 2024
Addresses #100, #102
- [x] Reference the issue your PR is fixing
- [x] Assign at least 1 reviewer for your PR
- [x] Test with run_dwelling.py or other script
- [x] Update documentation as appropriate
- [x] Update changelog as appropriate
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

No branches or pull requests

3 participants