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

docs: Use importlib.metadata to get version info #2477

Merged
merged 1 commit into from
May 14, 2024

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented May 14, 2024

Description

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* pkg_resources is deprecated as an API, so stop using it.
   - c.f. https://setuptools.pypa.io/en/latest/pkg_resources.html
* importlib.metadata.version is the recommended way to get package
  version information.
   - c.f. https://docs.python.org/3/library/importlib.metadata.html

* pkg_resources is deprecated as an API, so stop using it.
   - c.f. https://setuptools.pypa.io/en/latest/pkg_resources.html
* importlib.metadata.version is the recommended way to get package
  version information.
   - c.f. https://docs.python.org/3/library/importlib.metadata.html
@matthewfeickert matthewfeickert added docs Documentation related need-to-backport tmp label until can be backported to patch release branch labels May 14, 2024
@matthewfeickert matthewfeickert self-assigned this May 14, 2024
@matthewfeickert
Copy link
Member Author

I'm going to approve and merge this myself. As always, PRs approved by a single core dev can be reverted as needed by the rest of the dev team.

Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.21%. Comparing base (5b9c384) to head (813b732).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2477   +/-   ##
=======================================
  Coverage   98.21%   98.21%           
=======================================
  Files          69       69           
  Lines        4543     4543           
  Branches      804      804           
=======================================
  Hits         4462     4462           
  Misses         48       48           
  Partials       33       33           
Flag Coverage Δ
contrib 97.79% <ø> (ø)
doctest 98.08% <ø> (ø)
unittests-3.10 96.23% <ø> (ø)
unittests-3.11 96.23% <ø> (ø)
unittests-3.12 96.23% <ø> (ø)
unittests-3.8 96.25% <ø> (ø)
unittests-3.9 96.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@matthewfeickert matthewfeickert merged commit ecd0613 into main May 14, 2024
23 checks passed
@matthewfeickert matthewfeickert deleted the docs/use-importlib-metadata branch May 14, 2024 07:22
@matthewfeickert
Copy link
Member Author

@meeseeksdev backport to release/v0.7.x

meeseeksmachine pushed a commit to meeseeksmachine/pyhf that referenced this pull request May 30, 2024
@matthewfeickert matthewfeickert removed the need-to-backport tmp label until can be backported to patch release branch label May 30, 2024
matthewfeickert added a commit that referenced this pull request May 30, 2024
* Backport PR #2477
* pkg_resources is deprecated as an API, so stop using it.
   - c.f. https://setuptools.pypa.io/en/latest/pkg_resources.html
* importlib.metadata.version is the recommended way to get package
  version information.
   - c.f. https://docs.python.org/3/library/importlib.metadata.html

Co-authored-by: Matthew Feickert <matthew.feickert@cern.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant