Skip to content

Require setuptools 64.0.0+ #1193

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

Merged
merged 2 commits into from
Oct 18, 2022

Conversation

Saransh-cpp
Copy link
Contributor

I completely forgot that setuptools introduced editable installs in v64.0.0. This means that the installation will fail if a developer, who has setuptools < v64.0.0 installed locally, tries to install Zarr with pip install -e . right now.

With this PR, the local version of setuptools will be automatically updated to the compatible version.

For more information see this tweet - https://twitter.com/juanluisback/status/1557734536586625025?t=rzVtT-91AwzSOvBHanCJ9g&s=19

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@sanketverma1704
Copy link
Member

sanketverma1704 commented Oct 17, 2022

CC: @joshmoore @jakirkham

@jakirkham jakirkham changed the title Lower pin the compatible version of setuptools Require setuptools 64.0.0+ Oct 18, 2022
@jakirkham
Copy link
Member

Thanks Saransh! 🙏

Updated the PR title to make this a bit clearer (hope that is ok 🙂)

@jakirkham jakirkham enabled auto-merge (squash) October 18, 2022 20:30
@codecov
Copy link

codecov bot commented Oct 18, 2022

Codecov Report

Merging #1193 (04d3562) into main (361ca77) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1193   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files          35       35           
  Lines       14136    14135    -1     
=======================================
- Hits        14135    14134    -1     
  Misses          1        1           
Impacted Files Coverage Δ
zarr/util.py 100.00% <0.00%> (ø)

@jakirkham jakirkham merged commit d6ff3bb into zarr-developers:main Oct 18, 2022
@Saransh-cpp Saransh-cpp deleted the setuptools-lower-pin branch October 19, 2022 04:47
@joshmoore
Copy link
Member

Finally catching up with my email backlog, I'd like to add a request for help with keeping the release.rst entries up-to-date for PRs. It makes releases SO much easier.

@Saransh-cpp
Copy link
Contributor Author

I will update release.rst with my PRs.

It might also be nice to add an action that labels every PR with something like "needs changelog" if release.rst is not edited. The label would be removed as soon as the PR edits release.rst. This would ensure that the PRs are not merged before updating release.rst.

@joshmoore
Copy link
Member

joshmoore commented Nov 1, 2022

I will update release.rst with my PRs.

Thanks!

It might also be nice to add an action that labels every PR with something like "needs changelog" if release.rst is not edited.

@Saransh-cpp, definitely! Several of the ongoing tasks around rever and similar (e.g. #829) are for moving us closer to a simplification of the changelog, but until something like that is in place: I can use the help! :)

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.

4 participants