Add SSH username to Git over SSH documentation example

[WilliamDEdwards]

Description

The documentation at https://pip.pypa.io/en/stable/topics/vcs-support/#git contains the following example:

MyProject @ git+ssh://git.example.com/MyProject

However, the line should contain a username:

MyProject @ git+ssh://[email protected]/MyProject

Expected behavior

No response

pip version

21.2.4

Python version

3.9.6

OS

macOS 12.5

How to Reproduce

1. Run pip3 install 'MyProject @ git+ssh://git.example.com/MyProject' (without username)

Output

Without username:

(testvenv) williams-air:testvenv williamedwards$ pip3 install 'foobar @ git+ssh://example.com/foobar'
    fatal: '/foobar' does not appear to be a git repository
    fatal: Could not read from remote repository.

Code of Conduct

• I agree to follow the PSF Code of Conduct.

[sinoroc]

However, the line should contain a username

Why? Where does this requirement come from? As far as I can tell, this is not necessary. In the SSH configuration it is possible to associate a host name with a user name.

Maybe the documentation could show an example for both with and without a user name. And maybe also with and without password or would that be seen as (inadvertently) encouraging a bad practice?

[WilliamDEdwards]

However, the line should contain a username

Why? Where does this requirement come from? As far as I can tell, this is not necessary.

This can be found in the issue.

In the SSH configuration it is possible to associate a host name with a user name.

Expectations and prerequisites should be documented.

Maybe the documentation could show an example for both with and without a user name.

Commands should be usable with the default configuration.

And maybe also with and without password or would that be seen as (inadvertently) encouraging a bad practice?

Stick to the defaults. Advanced use cases should be handled by users themselves.

[sinoroc]

Right. Motivated like this, it seems to make much more sense than I initially thought. I agree.

[sinoroc]

@uranusjr Regarding the labels: there is already a PR: #11839