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 'req@url' syntax to install from remote VCS #2115

Merged
merged 3 commits into from
Feb 14, 2023

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Feb 10, 2023

Description

Resolves #2114

  • Use req@url syntax when using pip to install from a remote Git repository over url#egg=req to avoid the use of #egg= fragments with a non-PEP 508 name. This will be required in pip v25.0+. c.f. Restrict #egg= fragments to valid PEP 508 names pypa/pip#11617 for more details. This avoids pip throwing the following warning:

DEPRECATION: git+https://github.com/scikit-hep/pyhf.git#egg=pyhf[all] contains an egg fragment with a non-PEP 508 name pip 25.0 will enforce this behaviour change. A possible replacement is to use the req @ url syntax, and remove the egg fragment. Discussion can be found at pypa/pip#11617

  • For best practice, quote the use of extras for compatibility across all shells.

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
* Use 'req@url' syntax when using pip to install from a remote git
  repository over 'url#egg=req' to avoid the use of #egg= fragments
  with a non-PEP 508 name. This will be required in pip v25.0+.
   - c.f. https://github.com/pypa/pip/pull/11617 for more details.
* For best practice, quote the use of extras for compatibility across all shells.

@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix labels Feb 10, 2023
@matthewfeickert matthewfeickert self-assigned this Feb 10, 2023
@codecov
Copy link

codecov bot commented Feb 11, 2023

Codecov Report

Base: 98.30% // Head: 98.30% // No change to project coverage 👍

Coverage data is based on head (5e22958) compared to base (e80359f).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2115   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4531     4531           
  Branches      645      645           
=======================================
  Hits         4454     4454           
  Misses         45       45           
  Partials       32       32           
Flag Coverage Δ
contrib 97.88% <ø> (ø)
doctest 61.15% <ø> (ø)
unittests-3.10 96.31% <ø> (ø)
unittests-3.8 96.33% <ø> (ø)
unittests-3.9 96.35% <ø> (ø)

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

Impacted Files Coverage Δ
src/pyhf/cli/complete.py 100.00% <ø> (ø)
src/pyhf/cli/rootio.py 92.59% <ø> (ø)
src/pyhf/contrib/cli.py 100.00% <ø> (ø)
src/pyhf/contrib/utils.py 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

* Use 'req@url' syntax when using pip to install from a remote git
  repository over 'url#egg=req' to avoid the use of #egg= fragments
  with a non-PEP 508 name. This will be required in pip v25.0+.
   - c.f. https://github.com/pypa/pip/pull/ 11617 for more details.
@matthewfeickert matthewfeickert force-pushed the docs/remove-egg-fragments-from-pip-install-vcs branch from 4e30b35 to 5e22958 Compare February 13, 2023 06:13
@matthewfeickert
Copy link
Member Author

@matthewfeickert
Copy link
Member Author

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

@matthewfeickert matthewfeickert merged commit 8940361 into main Feb 14, 2023
@matthewfeickert matthewfeickert deleted the docs/remove-egg-fragments-from-pip-install-vcs branch February 14, 2023 16:07
matthewfeickert added a commit that referenced this pull request May 16, 2023
* Backport components of:
   - PR #2046
   - PR #2098
   - PR #2113
   - PR #2115
   - PR #2145
   - PR #2198
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

docs: Remove egg fragments from pip install syntax from VCS
1 participant