1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00
Commit graph

1469 commits

Author SHA1 Message Date
Pradyun Gedam 4a8693aa44
Build documentation with Sphinx 6 (#11904) 2023-03-27 19:52:23 +01:00
Stéphane Bidoul 0187bf6182
Merge pull request #11886 from sbidoul/clarify-install-report-docs
docs: clarify installation report note
2023-03-27 17:25:27 +02:00
Nikhil Ladha 5c61b2a52c
Configure sphinx-copybutton to strip prompts (#11702) 2023-03-27 16:23:02 +01:00
Stéphane Bidoul baeb627f3f docs: clarify installation report note
Update a note to reflect the fact that the report format is now stable.
2023-03-27 16:27:34 +02:00
Miro Hrončok ade38264b2
Make sphinx.ext.extlinks captions actual string templates (#11883) 2023-03-27 11:54:27 +01:00
Stéphane Bidoul 8271fdb349
Merge pull request #11763 from sbidoul/direct-url-hashes-part-2-sbi
Refine direct URL spec links in install report and inspect docs
2023-03-22 10:14:41 +01:00
Stéphane Bidoul 88b1ce5eec Add a few back quotes in docs 2023-03-22 10:11:06 +01:00
Stéphane Bidoul a04748db8e Remove support for the deprecated --install-options 2023-03-18 11:20:51 +01:00
Stéphane Bidoul 6ca4dbbb62
Merge pull request #11839 from WilliamDEdwards/fix/add-ssh-user-to-git-ssh
Add SSH username to Git over SSH documentation example
2023-03-18 10:44:40 +01:00
Stéphane Bidoul afb743c01c Update direct URL spec links 2023-03-18 10:28:32 +01:00
Tzu-ping Chung 5c3d1fed4a
Merge pull request #11698 from Darsstar/keyring-multi-choice 2023-03-15 18:07:07 +08:00
Matthew Feickert ced45695a0 Quote all install command components that aren't a bare package name
* As a means to make things easier for new users, quote everything in
  a `pip install` command that is part of a package that isn't just
  a bare package name.
* Use single quotes for Linux/Mac and use double quotes for Windows
  to follow existing style conventions.
2023-03-14 00:22:15 -05:00
Matthew Feickert 9a82bdfc52 Quote extras to guard shells with glob qualifiers
* Shells like zsh have glob qualifiers that will error if an extra
  is not quoted. While the glob qualifiers can be disabled, adding
  quotes guards against errors if people are copy-pasting or do not
  know that they can disable the behavior.
* Use single quotes for Linux/Mac and use double quotes for Windows
  to follow existing style conventions.
2023-03-14 00:22:15 -05:00
William Edwards 5296a234c8 Add SSH username to Git over SSH documentation example
```

(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.

(testvenv) williams-air:testvenv williamedwards$ pip3 install 'foobar @ git+ssh://git@example.com/foobar'
...
Successfully installed foobar-0.0
```
2023-03-05 12:10:53 +01:00
Dos Moonen 6affad8032 Merge branch 'main' into keyring-multi-choice
# Conflicts:
#	src/pip/_internal/network/auth.py
2023-02-21 14:02:32 +01:00
Tzu-ping Chung 56e5fa3c0f
Merge pull request #11487 from pelson/feature/base-prefix-config 2023-02-01 01:40:09 +08:00
Dos Moonen 7b75fda0c6 Typo in documentation: s/if/is 2023-01-30 09:01:03 +01:00
Tzu-ping Chung 0a9ff9de23 Revise documentation on keyring 2023-01-30 09:01:02 +01:00
Dos Moonen 33cd541cc4 Make it possible to request a keyring provider: auto, disabled, import or subprocess
Refactored `_get_index_url()` to get integration tests for the subprocess backend working.

Keyring support via the 'subprocess' provider can only retrieve a password, not a username-password combo. The username therefor MUST come from the URL.
If the URL obtained from the index does not contain a username then the username from a matching index is used. `_get_index_url()` does that matching.

The problem this refactoring solves is that the URL where a wheel or sdist can be downloaded from does not always start with the index url. Azure DevOps Artifacts Feeds are an example since it replaces the friendly name of the Feed with the GUID of the Feed. Causing `url.startswith(prefix)` to evaluate as `False`.

The new behaviour is to return the index which matches the netloc and has the longest common prefix of the `path` property of the value returned by `urllib.parse.urlsplit()`. The behaviour for resolving ties is unspecified.
2023-01-30 09:00:59 +01:00
Stéphane Bidoul ec7eb6f179 Add version history to inspect and install report docs 2023-01-29 12:43:23 +01:00
Stéphane Bidoul 169511e68e Update direct URL hashes examples 2023-01-29 12:43:21 +01:00
Pradyun Gedam fc747ca912
Merge pull request #11592 from judahrand/keyring-cli 2023-01-28 22:45:49 +00:00
Stéphane Bidoul 126e6f67a5 Install report format declared stable 2023-01-28 14:15:04 +01:00
Stéphane Bidoul 99dddc1616 pip inspect format declared stable 2023-01-28 14:15:04 +01:00
Pradyun Gedam e69e265cb7
Merge pull request #11731 from cnpryer/docs-fix 2023-01-22 12:59:09 +00:00
Muha Ajjan‮ b99a6fe012
Rename Unix to Linux
this keeps the tabs under "Default paths" and "Avoiding caching" in sync

to reproduce the issue this commit solves, go to this page:
https://pip.pypa.io/en/stable/topics/caching/
then change the tabs under one of the sections, notice how changing to Unix / Linux breaks sync due to PipCLIDirective using the name [Linux](95a58e7ba5/docs/pip_sphinxext.py (L231)) for Unix based OS's
2023-01-21 11:24:26 +01:00
Chris Pryer 950522e456
Fix docs 2023-01-19 21:45:29 -05:00
Jason Curtis 898b0fced4
minor installation.md docs typo 2023-01-16 14:01:00 -08:00
Joonatan Partanen 07a360dfe8
Mention build-backend in regular/editable install differences (#11691)
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
2023-01-09 12:42:52 +00:00
Stéphane Bidoul 668ea3f6f3 Clarify the role of the egg URL fragment 2022-12-28 23:24:53 +01:00
Pradyun Gedam b224c38732
Merge pull request #11675 from sbidoul/fix-vcs-support-docs 2022-12-28 20:14:42 +00:00
Stéphane Bidoul e22003e0e1 Update VCS support documentation
Now that PEP 610 (direct_url.json) is implemented, an editable install
is not required anymore for pip freeze to work correctly.
2022-12-28 12:19:21 +01:00
William Woodruff 3b9abbc987
topics/vcs-support: re-qualify egg fragment behavior
Signed-off-by: William Woodruff <william@trailofbits.com>
2022-12-02 21:12:47 -08:00
Tzu-ping Chung 8d34a1111d
Merge branch 'main' into feature/base-prefix-config 2022-11-25 09:38:56 +08:00
William Woodruff e26712616e
topics/vcs-support: clarify the egg fragment's syntax
This doesn't actually address the semantics of extras in the
egg fragment.

Signed-off-by: William Woodruff <william@trailofbits.com>
2022-11-22 17:04:23 -05:00
Dimitri Papadopoulos 1273c7a969
Fix typos found by codespell 2022-11-20 13:27:39 +01:00
Phil Elson 81d6053ee3 Use the VIRTUAL_ENV environment variable in the configuration documentation
This follows the discussion in https://github.com/pypa/pip/pull/11487/files#r988625394,
that despite the VIRTUAL_ENV environment variable not being the technically correct
value, it is more readily understood by readers than ``sys.prefix``.
2022-11-17 17:31:26 +01:00
Rishi ba0e3ac6f4
Update the macos tag in pip download docs (#11603) 2022-11-16 21:55:47 +00:00
Phil Elson 93ade8586e
Update docs/html/topics/configuration.md
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2022-11-16 21:17:33 +01:00
Tzu-ping Chung 4a87ab04c8
Merge branch 'main' into feature/base-prefix-config 2022-11-16 12:50:52 +08:00
Paul Moore 31ebba23d7 Update release docs to clarify some points 2022-11-12 11:46:20 +00:00
Judah Rand 89a4a35a33
Add documentation on functionality in #11589 2022-11-11 21:44:35 +00:00
Holly Stotelmyer 8f34d86a1e
Add section clarifying pip version support (#11556)
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
2022-10-27 16:28:21 -05:00
Pradyun Gedam 21752556f1
Merge pull request #11272 from federicober/patch-1 2022-10-07 11:59:40 +01:00
Phil Elson b777bcda81 Add the "base" config level concept, to allow configuration of all virtual environments sharing the same base.
The new functionality serves a use case which was not previously possible with pip configuration files, namely the situation where you have a base Python installation and want to influence the pip configuration for all derivative virtual environments *without* changing the config for all other environments on a machine (global), or for all other environment run by the same user (user). Concretely, this could be used for a centrally managed network mounted filesystem based Python installation, from which multiple users can build virtual environments and inside which a specific pip configuration is needed (e.g. an index URL).
2022-10-06 09:33:38 +02:00
Paul Moore eb1b1204af
Merge pull request #11479 from cjolowicz/docs-typos
Fix typos in HTML docs
2022-10-03 11:57:29 +01:00
Paul Moore 970b53d030
Merge pull request #10247 from pfmoore/resolver_details
Document the new resolver
2022-10-03 11:14:26 +01:00
Claudio Jolowicz f3b91157af
Fix typos in HTML docs 2022-10-03 12:00:14 +02:00
Paul Moore 550027d016 Add a 'work in progress' note to the document 2022-10-02 12:17:52 +01:00
Paul Moore be40ec8405 Merge branch 'main' into resolver_details 2022-10-02 12:10:13 +01:00