Commit Graph

1015 Commits

Author SHA1 Message Date
Pradyun Gedam 997db009b2
Update documentation for package finding 2019-11-10 14:12:56 +05:30
Pradyun Gedam 1308270723
Switch to using just nox commands in the release process 2019-11-10 12:18:20 +05:30
Aniruddha Basak 0d0ee9b407 Modify URL and give information of enterprise environments supporting older Pythons and pips 2019-11-09 15:34:58 +05:30
Stéphane Bidoul (ACSONE) 9cad519521
Cache wheels built from immutable Git requirements
Cache wheels that are built from Git requirements
that contain an immutable revision (i.e. a sha).
2019-11-03 22:54:33 +01:00
Pradyun Gedam ca53a8bc56
Document the simplified release process 2019-11-03 14:48:21 +05:30
Christopher Hunt 553824477d
Merge pull request #7195 from ananyo2012/utf8-doc
Document that "coding: utf-8" is supported in requirements.txt
2019-11-01 11:26:48 +08:00
Ananya Maiti bb047aa263 Document that "coding: utf-8" is supported in requirements.txt
Fixes #7182
2019-10-31 20:27:00 +05:30
Xavier Fernandez 01c953b95d docs: Add basic documentation about our CI setup 2019-10-31 15:39:07 +01:00
Aniruddha Basak 69e0178a54 Add description about the examples 2019-10-25 16:40:05 +05:30
Aniruddha Basak 23bac8f574 Add https:// in the login token example 2019-10-25 00:51:40 +05:30
Christopher Hunt ccfd119673
Merge pull request #7241 from xavfernandez/update_release_doc
Update release doc
2019-10-20 09:16:40 -04:00
Xavier Fernandez 7c218c9a80 Update the patch release process 2019-10-19 22:53:29 +02:00
Xavier Fernandez cb8564c6e1 docs: add notes regarding ``get-pip.py`` during the release 2019-10-19 22:52:45 +02:00
Pradyun Gedam 6d96b85388
Update the URL fragment to not include "py"
I'm making this change since it's unlikely that folks would've linked to
this specific section, and if they did, this isn't exactly user facing
documentation, so I wouldn't hold this to the same standard.
2019-10-19 22:31:45 +05:30
Pradyun Gedam 2399a26cb1
Remove remaining references to index.py 2019-10-19 22:29:19 +05:30
Pradyun Gedam 3846da7f71
Update docs/html/development/architecture/package-finding.rst
Co-Authored-By: Ellen Marie Dash <the@smallest.dog>
2019-10-19 22:24:53 +05:30
Pradyun Gedam 6ea84c6145
Update docs to refer to index as a sub-package 2019-10-19 22:22:12 +05:30
Aniruddha Basak f7a0065636 Add block in the code snippet 2019-10-19 22:21:59 +05:30
Aniruddha Basak 4d968f5ff3 Add url with special charecter and single part token 2019-10-19 22:06:11 +05:30
Christopher Hunt fde92e72a4
Merge pull request #7219 from hugovk/add-3.8
Declare support for Python 3.8
2019-10-17 09:22:03 -04:00
everdimension 3b8e2f3749 Rephrase installation instructions
Make it a bit more clear that the goal is to just
download the get-pip.py file and that the curl command
is not required
2019-10-16 22:04:23 +02:00
Shovan Maity 852d996c40 (improve doc): add command to run test in parallel (#7189) 2019-10-15 22:50:38 +02:00
hugovk d65bf5021a Update docs about Python 3.8 2019-10-15 20:06:29 +03:00
Aniruddha Basak 5fb94298cf Fix whitespace 2019-10-15 12:22:47 +05:30
Aniruddha Basak 3e326a017b Fix typo 2019-10-15 12:09:42 +05:30
Xavier Fernandez 8df9329396 Add release target 2019-10-14 14:23:00 +02:00
Aniruddha Basak 1e46e6c48d Added description for basic auth credentials 2019-10-14 17:21:24 +05:30
Christopher Hunt 5a997b7509
Merge pull request #7065 from chrahunt/pr-5955
Explicit support for hg+file
2019-10-06 09:39:42 -04:00
gpiks f006a7b262 Clarify `--no-binary` when enumerating packages and add an example
Minor tweak to `--no-binary` documentation to specify that when
enumerating packages, the colons are not needed. Additionally,
add an example to demonstrate building a wheel from source.
2019-09-30 22:22:35 -04:00
John Paton d6128bebe5 change filename in docs 2019-09-30 09:56:44 +02:00
John Paton 6b57c1f5df Move outdated outside utils and rename (pypa/pip#6532) 2019-09-30 09:56:44 +02:00
Chris Hunt dc50948c3c Single backticks to double backticks in triage guide 2019-09-29 11:27:06 -04:00
Pradyun Gedam 6b74f2eccb
Initial triage guide (#6868) 2019-09-29 12:32:27 +05:30
Pradyun Gedam 5713057db2
Rewrap all of user_guide.rst at 80 characters 2019-09-26 13:21:40 +05:30
Pradyun Gedam b926290a50
Merge pull request #7078 from pradyunsg/revamp-linting-processes
Revamp linting processes
2019-09-25 20:57:36 +05:30
Pradyun Gedam 45bc66ae1a
Add a space I missed. 2019-09-24 22:13:14 +05:30
Pradyun Gedam c47e1b6e5d
Enable rst-backticks for ReST files and NEWS fragments 2019-09-24 18:03:22 +05:30
Pradyun Gedam 7224a1155c
Enable trailing-whitespace 2019-09-24 18:03:22 +05:30
Pradyun Gedam 6f8c29aa77
Enable end-of-file-fixer 2019-09-24 18:03:22 +05:30
Pradyun Gedam 0a25c7d4a6
Document that pre-commit is used for linting 2019-09-24 18:03:22 +05:30
Pradyun Gedam 3b0f2c32dd
Make the role of tox, in test running, clearer 2019-09-24 17:07:10 +05:30
Pradyun Gedam 2bbbc0756a
Oops! I'd missed a word. 2019-09-24 17:07:10 +05:30
Pradyun Gedam 96fd796334
Some hand-holding to tell folks to install Python 2019-09-24 17:07:10 +05:30
Pradyun Gedam d0df9d375f
Drop references to lint-py2 and mypy in documentation 2019-09-24 17:03:39 +05:30
Chris Hunt 05964ead48 Address previous review comments 2019-09-22 11:10:25 -04:00
Adam Tse 3f98ee4250 Explicit support and tests for `hg+file` scheme for `pip install`. 2019-09-22 11:04:23 -04:00
Chris Hunt 2a4cfcb021 Address review comments. 2019-09-20 20:09:49 -04:00
Chris Hunt a8996f25e5 Initial triage guide. 2019-09-20 20:09:49 -04:00
Christopher Hunt cdbda9bfd3
Merge pull request #7022 from chrahunt/docs/triage-guide-1
Add triage guide document.
2019-09-19 07:48:19 -04:00
Chris Hunt 80339aab2c Add WIP note 2019-09-19 01:53:02 -04:00
Christopher Hunt 82c2dd40eb
Merge pull request #6203 from vinicyusmacedo/fix-pep-508
Fix is_url from splitting the scheme incorrectly when using PEP 440's direct references
2019-09-16 09:52:40 -04:00
Chris Hunt 42cbd3c737 Add triage guide document.
Includes basic issue tracker info, as a first step towards the full
document.
2019-09-15 13:22:38 -04:00
Chris Jerdonek ca4fc9e741 Update architecture/package-finding.rst. 2019-09-12 02:31:45 -07:00
Pradyun Gedam 79ce923e1a
Update documented invocations of generate commands 2019-09-05 12:40:34 +05:30
Pradyun Gedam 3b2d138400
Rename `tox lint-py3` to `tox lint`
Merge pull request #6934 from pradyunsg/lint-python3-default
2019-08-27 17:09:01 +05:30
Pradyun Gedam 506a08bc38
Rename `tox lint-py3` to `tox lint`
Also update references to it, in Travis CI config and in documentation.
2019-08-27 13:55:20 +05:30
Sumana Harihareswara 289af52b59 Add WIP note 2019-08-22 12:42:35 -04:00
Pradyun Gedam 9b82fcc9d8
Merge branch 'master' into architecture 2019-08-22 21:07:58 +05:30
Pradyun Gedam f0d48d1897
Merge pull request #6901 from pypa/pradyunsg-docs-improve-note
Note that pip's internals can change at any time
2019-08-22 12:50:47 +05:30
Chris Jerdonek e888587c68
Note that pip's internals can change at any time 2019-08-21 15:51:38 +05:30
Chris Jerdonek 8db3944a64 Add initial architecture section for index.py and PackageFinder. 2019-08-20 22:49:30 -07:00
Sumana Harihareswara 9b0383ea6c WIP improve linking and formatting 2019-08-13 19:21:01 -04:00
Sumana Harihareswara 72094355dc WIP polish formatting 2019-08-13 19:21:01 -04:00
Sumana Harihareswara f6a4c71c95 WIP fixing errors 2019-08-13 19:21:01 -04:00
Sumana Harihareswara 165e5a33ff WIP reorganizing 2019-08-13 19:21:01 -04:00
Sumana Harihareswara c03335502a WIP formatting of source section 2019-08-13 19:21:01 -04:00
Sumana Harihareswara 7e51405806 WIP reformatting as nested list 2019-08-13 19:21:01 -04:00
Sumana Harihareswara 8f2d28b563 WIP to squash 2019-08-13 19:21:01 -04:00
Sumana Harihareswara 7662d840ed Polish formatting and wording 2019-08-13 19:21:01 -04:00
Sumana Harihareswara 4b8ecd6f2d Add architecture overview. 2019-08-13 19:21:01 -04:00
Vinicyus Macedo 16af35c613 Adding improvements to the _get_path_to_url function 2019-08-12 14:32:03 -03:00
Pradyun Gedam 7c319ad74a
Add a skeleton for architecture documentation (#6836) 2019-08-07 02:41:00 +05:30
Pradyun Gedam 5280483c06
Clarify who we welcome help from 2019-08-07 02:40:08 +05:30
Paul Moore e4c32b9917
Merge pull request #6770 from omry/master
exclude '.tox', '.nox' from being copied during 'pip install .'
2019-08-05 23:29:02 +01:00
Pradyun Gedam 1429a55f40
Add a skeleton for architecture documentation 2019-08-05 17:51:28 +05:30
Omry Yadan 6dd5727773 responded to comments 2019-08-03 11:14:36 -07:00
Omry Yadan ec47c866c8 updated docs 2019-08-03 10:31:42 -07:00
Chris Jerdonek 1f09e67f34 Only import a Command class when it is actually needed.
This resulted in an approximate 24% speed-up of a vanilla `pip`
invocation on one system (0.477 secs before, 0.363 secs after).
2019-07-26 23:30:26 -04:00
Pradyun Gedam 8de817c7ed
Reword as suggested in PR review 2019-07-20 09:37:48 +05:30
Pradyun Gedam 6057e6c344
Document how Python 2.7 support will be handled 2019-07-20 09:37:47 +05:30
Xavier Fernandez ab10b8c328 debug: add warnings about its provisional status 2019-07-18 14:39:12 +02:00
Xavier Fernandez d70edc8a95 docs: add basic documentation for pip debug 2019-07-18 14:39:12 +02:00
Xavier Fernandez 8f45aee97a Fix line length & don't flake8 docs in python 2 2019-07-18 14:37:31 +02:00
Eli Schwartz 1350b95dee
docs: fix manpage generation
This was broken in commit 20f672c4e6,
which reorganized the conf.py file into the html subdirectory. See:
https://github.com/pypa/pip/pull/5724
https://github.com/readthedocs/readthedocs.org/issues/1543

This broke the relative manpage globbing because Sphinx will os.chdir()
into the directory location of conf.py before evaluating it, so the
globbing returned nothing at all. As a result, while the main pip(1)
manpage continued to be built, no pip-*(1) subcommand manpages were
built.
2019-07-17 23:53:50 -04:00
Eli Schwartz f2cbcd190f
docs: check that the subcommand manpages are actually found and being used 2019-07-17 23:52:44 -04:00
Eli Schwartz f3f63c0f82
docs: fix manpage names being truncated
In commit d2e7377c0f, the documentation
directories were reorganized, resulting in `fname_base` (the path that
Sphinx looked for source files) to no longer expect the leading 'man/'.
This was always also stripped from the `outname`, which now strips four
characters twice over.

Fix by reducing the stripped length to only the length of the prefix in
fname_base itself.
2019-07-17 22:53:17 -04:00
Hugo 2c1010ee96 Drop support for EOL Python 3.4 2019-07-07 11:45:16 +03:00
Pradyun Gedam a8c66dc5d7
Merge pull request #6007 from smartsammler/fix-iss4733
Fix #4733 by deleting the failing example
2019-07-06 09:18:58 +05:30
Pradyun Gedam f196814b71
Soften language in note for Installation Order 2019-06-16 19:34:19 +05:30
Pradyun Gedam 3c17e280f5
Add another colon to make it ReST directive 2019-06-16 18:27:00 +05:30
Pradyun Gedam 61c4b6159c
Add a disclaimer to the "Installation Order" section (#6604) 2019-06-16 17:43:28 +05:30
Pradyun Gedam cbb2a5e6ad
Add a disclaimer to the "Installation Order" section
This section has caused a lot of user confusion since PEP 517/518. It seems that users are referring to this section for advice about how to deal with build time issues, which contains statements that do not hold true for build requirements.
2019-06-13 16:57:07 +05:30
Chris Jerdonek d72758394d Fully support --trusted-host inside requirements files. 2019-06-13 01:21:05 -07:00
Abhinav Sagar 107258da0b Document issue tracker triage as a contribution area (#6569) 2019-06-05 06:36:32 +05:30
Stéphane Bidoul (ACSONE) 99b64ba80f docs: mention installing from git refs 2019-05-18 12:02:28 +02:00
ABHYUDAY PRATAP SINGH a731e7e37d Docs: capitalize "URL" 2019-05-10 22:52:21 +02:00
Pulkit Goyal d2742a9049 Improve sentence about PyPI package search (#6476) 2019-05-07 14:30:39 -04:00
Chris Jerdonek a163ae5af1
Fix some formatting issues in the pip-install docs (#6432) 2019-05-07 09:13:56 -04:00
Albert Tugushev 7130b1d0e0 Fix option name for smart quotes in sphinxdoc conf (#6422)
Also configure the smartquotes_action to exclude dashes from transformation.
See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes
2019-04-21 09:51:42 -07:00
Caleb Martinez ac9010e87c Allow adding a custom string to pip's User-Agent via an environment variable (#5550) 2019-03-31 02:37:02 -07:00
Pi Delport 5f3c56e188 Fix some typos 2019-03-12 21:54:18 +01:00
jakirkham 9360648b34
Remove extra `.` 2019-02-28 13:10:24 -05:00
Pradyun Gedam 45d16ac83e
Remove note about flake8 noqa comments 2019-02-25 22:10:00 +05:30
Nick Coghlan 682cff7230 Fix #6163: Default to setuptools.build_meta:__legacy__
The main setuptools PEP 517 backend is intended for
explicit usage in `pyproject.toml`, when the project
authors can ensure that their `setup.py` runs without
that directory being implicitly on `sys.path`.

For implicit usage, setuptools now offers a separate
legacy backend that more closely mimics direct
execution of the `setup.py` script.
2019-02-06 20:57:57 +10:00
Pradyun Gedam 98654c8761
Replace link to virtualenv-users with Discourse Packaging channel 2019-01-29 14:09:47 +05:30
Thea Flowers dc5c13d547 Address comments 2019-01-28 10:05:23 -08:00
Thea Flowers f7d84b117e Update index 2019-01-25 11:27:55 -08:00
Albert-Guan 465261a828 Document that empty environment variables are not treated as false (#5953) 2018-11-24 19:30:41 +05:30
Donald Stufft 51eb885e78 Add a release task to upgrade CPython's bundled pip 2018-11-19 07:39:10 -05:00
Paul Moore 3a77bd667c
Merge pull request #5743 from pfmoore/pep517
PEP 517 implementation
2018-11-15 09:32:17 +00:00
Paul Moore cf4d84e58f Address doc review comments 2018-11-14 13:15:55 +00:00
Pradyun Gedam 507b90e117
Merge pull request #5949 from kynan/extend-docs
Add instructions for running pip from source to docs
2018-11-13 21:21:43 +05:30
Julian Gethmann f92ac73ccd Fix pypa#4733 by changing the failing example
This example did not make sense unless it was possible to install specify a
version of a package one installs referencing by the path (here: `.`).
A new example for the local installation with an extra has been added
instead.
2018-11-12 17:08:45 +01:00
Paul Moore 4ca38e0c38 Merge with master 2018-11-11 13:49:35 +00:00
Pradyun Gedam 9bb184d1f2
Fix line-too-long linter message 2018-11-08 12:35:05 +05:30
Xavier Fernandez 38298779a1
Merge pull request #5986 from Albert-Guan/ISSUE5984
Issue5984
2018-11-07 10:50:51 +01:00
xtreak 3ee456033c Change download example to use --destination-directory 2018-11-05 11:00:01 +00:00
albertg 1e654ad038 add command name for reference documents 2018-11-04 16:03:11 -05:00
xtreak 0900b4c3ff Fix pip download example in usage 2018-11-01 17:58:48 +00:00
Pradyun Gedam ca848a5068
Merge pull request #5958 from pradyunsg/docs/vendoring-info-from-docs
Include the Vendoring policy in the docs
2018-10-30 10:45:45 +00:00
Paul Moore a4c7d7d996 Add documentation 2018-10-29 23:33:21 +01:00
Florian Rathgeber b911f65365 Remove mention of virtualenv 2018-10-28 23:48:19 +00:00
Florian Rathgeber 044fdda942 Switch to running src/pip now #5481 is merged 2018-10-28 14:22:59 +00:00
Florian Rathgeber afe41d4c07 And some notes and caveats 2018-10-28 14:20:02 +00:00
Florian Rathgeber 8e9ef24ae4 Add instructions for running pip from source to docs 2018-10-28 14:20:02 +00:00
Pradyun Gedam bc9c51292a
Include the Vendoring policy in the docs 2018-10-28 11:27:28 +00:00
AceGentile 69037caa0c remove egg version from pip install command reference
fix #5888
2018-10-27 12:51:57 +02:00
Pradyun Gedam e19aceff40
Merge branch 'master' into appveyor-rename 2018-10-23 19:20:46 +05:30
Pradyun Gedam 06ccf39bc3
Merge pull request #5814 from pradyunsg/docs/reduce-heading-level
Reduce the heading level
2018-10-22 12:31:15 +05:30
Pradyun Gedam 5167495eb7
Rename appveyor.yml -> .appveyor.yml and update references 2018-10-22 12:16:43 +05:30
Benoit Pierre 83b879b1ec Improve PEP 518 build isolation (#5824)
Handle .pth files, so namespace packages are correctly supported under Python 3.2 and earlier, and more.
2018-10-16 12:04:28 +05:30
Pradyun Gedam dbf758a514
Reduce the heading level 2018-09-26 11:29:19 +05:30
Donald Stufft 3065bea8f9 get-pip.py is mostly a giant base85'd blob and can't be reviewed 2018-09-24 16:37:33 -04:00
Pradyun Gedam 20f672c4e6
Move conf.py into the html directory, to be compatible with RTD
Also add a small comment explaining why this has been done.
2018-08-22 16:33:16 +05:30
Pradyun Gedam d2e7377c0f
Reorganize pip's docs folder 2018-08-22 13:54:47 +05:30
Pradyun Gedam 2b3609a37d
Merge pull request #5664 from cjerdonek/issue-5375-svn-ssh-auth
Fix #5375: add editable install support for svn+ssh URLs with a username
2018-08-22 08:33:08 +05:30
Pradyun Gedam cc47adee9a
Change the import names as renamed 2018-08-05 14:24:18 +05:30
Pradyun Gedam 8650edd017
Merge pull request #5561 from pradyunsg/python-3.7
Document support for Py3.7 and enable testing of Py3.8-dev
2018-07-30 08:27:48 +05:30
Chris Jerdonek e1d60f850b Fix #5375: add editable install support for svn+ssh URLs with a username. 2018-07-29 01:08:15 -07:00
Pradyun Gedam 3e81d8cde1
Merge pull request #5653 from pradyunsg/docs/update-release-process
Improve content in "Creating New Release" section
2018-07-28 23:22:47 +05:30
Pradyun Gedam b3473b329d
Merge branch 'master' into python-3.7 2018-07-24 23:08:09 +05:30
Pradyun Gedam 43359d75b6
Address review comments from @pfmoore 2018-07-24 23:06:25 +05:30
Pradyun Gedam 13ca6bffc4
Improve text in create new release section
- Break up points that involve checking out git refs
- Include supporting comment for bumping version
- Drop outdated reference to "CHANGES.txt"
- Provide a link to get-pip repository
- Drop the outdated get-pip.py generation command
- Put all commmands that can be executed in parenthesis
2018-07-24 18:02:05 +05:30
Pradyun Gedam bcc8fa8069
Remove redundant files from docs/ directory 2018-07-24 13:03:19 +05:30
Pradyun Gedam 4e8c247154
Document platforms/tooling new pip maintainers can be given access to 2018-07-24 10:54:51 +05:30
Pradyun Gedam ef6c2f7229
Merge pull request #5635 from jcfr/fix-userguide-reference
user_guide: Fix "Requirements Files" reference
2018-07-24 08:45:04 +05:30
Pradyun Gedam 0734255da3
Don't mention pip in the headers of development docs pages 2018-07-24 01:18:12 +05:30
Pradyun Gedam 468e38fcf9
Add a note saying older references might be broken 2018-07-24 00:58:20 +05:30
Jean-Christophe Fillion-Robin 9c92c618a4
user_guide: Fix "Requirements Files" reference 2018-07-22 14:13:34 -04:00
Pradyun Gedam 47e8703241
Add the deprecation helper information from b6dae7a594 2018-07-22 18:34:01 +05:30