Use req @ url syntax to install from remote VCS

[matthewfeickert]

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 pip#11617 for more details.

[matthewfeickert]

This is ready for review. Let me know if you have any questions. 👍

cc @pradyunsg @pfmoore given their involvement in pypa/pip#11617

[pradyunsg]

Could you add whitespace around @? IMO that makes it clearer and easier to read.

[matthewfeickert]

Could you add whitespace around @? IMO that makes it clearer and easier to read.

Sure. I applied that universally, rebased, and force-with-lease pushed back.

[sinoroc]

There are issues with sub-directories.

pip install "git+https://example.com/repo/app.git#egg=app&subdirectory=setup

was transformed into

pip install "app&subdirectory=setup @ git+https://example.com/repo/app.git"

which does not seem correct to me. Is it?

[matthewfeickert]

@sinoroc do you have a failing example?

@pradyunsg you were BDFL-Delegate for PEP 610 so maybe you can comment more here.

[sinoroc]

I might be wrong, but I do not think it has anything to do with "PEP 610 – Recording the Direct URL Origin of installed distributions". The issue is that this is not a valid requirement notation for the pip CLI.

The best I can find is this section of pip's documentation on "URL fragments" in "VCS Support" which lists two accepted notations for VCS with subdirectory:

• python -m pip install "pkg @ vcs+protocol://repo_url/#subdirectory=pkg_dir"
• python -m pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"

[matthewfeickert]

Thanks @sinoroc. Indeed it looks like

python -m pip install "pkg @ vcs+protocol://repo_url/#subdirectory=pkg_dir"

is what should have been done. I'll open up a fix PR with this correction once I've finished making coffee.