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

867 commits

Author SHA1 Message Date
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
Pradyun Gedam
5fceb47be8
Merge branch 'master' into docs/improve-dev-docs 2018-07-22 18:32:57 +05:30
Pradyun Gedam
0bd01d9462
Merge pull request #5336 from benoit-pierre/src_build_reqs_in_pep518
PEP 518: enable source installs for build dependencies
2018-07-20 09:36:52 +05:30
Pradyun Gedam
169ca95666
Merge pull request #5542 from pradyunsg/dev-ops/deprecation-utilities
Introduce a helper function for deprecation
2018-07-20 00:37:53 +05:30
Pradyun Gedam
3c073f92f4
Add the deprecation policy changes from fde9eb66f0 2018-07-17 13:59:41 +05:30
Pradyun Gedam
1933dacc89
Merge branch 'master' into docs/improve-dev-docs 2018-07-17 13:59:06 +05:30
Pradyun Gedam
067dd8c2c4
Merge pull request #5574 from javabrett/proxy-doc
Added User Guide section on proxy configuration.
2018-07-15 18:04:11 +05:30
Pradyun Gedam
b6dae7a594
Mention the helper along with pip's deprecation policy 2018-07-15 17:15:36 +05:30
Pradyun Gedam
de899dd62d
Merge pull request #5553 from ashtyrov/master
Fix issue #5532
2018-07-15 16:01:51 +05:30
Pradyun Gedam
549cdebf96
Remove redundant newline 2018-07-15 15:55:27 +05:30
Chris Jerdonek
ae3705972c Fix typo: tools/test-requirements.txt. 2018-07-11 01:04:03 -07:00
Brett Randall
3401f4de51 Added User Guide section on proxy configuration. Fixed #512.
Signed-off-by: Brett Randall <javabrett@gmail.com>
2018-07-10 22:35:54 +10:00
gkdoc
763d2a761f
Remove redundancies in list in user_guide.rst 2018-07-06 21:33:14 -07:00
Donald Stufft
fde9eb66f0 Adjust the deprecation policy to be time based 2018-07-06 12:35:29 -04:00
Pradyun Gedam
4ba6769a68
Merge pull request #5530 from pradyunsg/misc/simplify-linter-use
Simplify linter use and make configuration consistent
2018-07-04 14:27:33 +05:30
Pradyun Gedam
26d45a667d
Document and test support for Py3.7 2018-07-03 01:01:15 +05:30
Pradyun Gedam
98ddd2dddc
Improve "Submitting Pull Requests" section
- Link to compatibility requirements and require compliance
- Move licensing details to come earlier
- Reword text on cosmetic changes
2018-07-02 20:05:17 +05:30
Pradyun Gedam
60ef05b013
Provide examples of running specific tests using tox 2018-07-02 19:38:36 +05:30
Pradyun Gedam
2b57b8dc36
Mention that pip is volunteer maintained 2018-07-02 19:38:14 +05:30
Pradyun Gedam
0db7d17ea5
Don't mention various ways to contribute 2018-07-02 19:37:52 +05:30
Pradyun Gedam
868dd687bd
Polish the Release Process documentation 2018-07-02 19:02:12 +05:30
Pradyun Gedam
2e9e42bc33
Use newer development docs 2018-07-02 19:02:12 +05:30
Pradyun Gedam
ff1cdc7c6e
Add shorthand for pypi projects 2018-07-02 19:02:11 +05:30
Pradyun Gedam
8344642207
Document how to rebase a branch 2018-07-02 19:02:11 +05:30
Pradyun Gedam
b6cdf5dbf0
Document how to submit pull requests 2018-07-02 19:02:11 +05:30
Pradyun Gedam
c1780e0381
Add a new section documenting development processes 2018-07-02 19:02:11 +05:30
Pradyun Gedam
8891656e40
Move and expand contribution related notes 2018-07-02 19:02:11 +05:30
Pradyun Gedam
bf0d736fc0
Move release-process docs to separate page 2018-07-02 19:02:11 +05:30
Pradyun Gedam
30dcc7dfad
Start breaking development documentation 2018-07-02 19:02:11 +05:30
Alexander Shtyrov
8f70a5b57a Wrapped text to 80 characters. 2018-06-30 13:26:05 +01:00
Alexander Shtyrov
fdf753ff63 Modify the wording of the installation instructions. Fixes #5532 2018-06-29 17:47:58 +01:00
Ernest W Durbin III
bcb75acf5c
get-pip: add notes to docs for specifying versions
get-pip.py supports installing specified versions of pip, wheel, setuptools...
and any dependency for that matter, but this is not clearly exposed in
the documentation at https://pip.pypa.io/en/stable/installing/#installing-with-get-pip-py
2018-06-29 10:19:58 -04:00
Benoit Pierre
3ae521974f enable source installs for build dependencies 2018-06-26 10:40:23 +02:00
Pradyun Gedam
c2b1ce9fdc
Fix lint errors on newly covered files 2018-06-25 17:04:00 +05:30
kpinc
873662179a Use Sphinx :pep: syntax to link PEPs (#5491)
Creating a news entry from the pull request as a separate commit.  Does this warrant an issue?
2018-06-25 16:13:59 +05:30
Pradyun Gedam
577ba77a88
Merge pull request #5510 from pradyunsg/dev-ops/tools-directory
Add a new tools/ directory and move some files into it
2018-06-20 16:22:58 +05:30
Pradyun Gedam
4fedc45bbb
Merge pull request #5489 from jdufresne/https
Update doc and comment URLs to https where available
2018-06-20 12:49:35 +05:30
Pradyun Gedam
9e03fe4c82
Mention complete path in docs for tests-requirements.txt 2018-06-16 16:42:51 +05:30
Pradyun Gedam
93cdb4d243
Update docs reference 2018-06-16 09:37:10 +05:30
kpinc
d0b40a09de Change sentence from future to present tense (#5490) 2018-06-14 10:07:27 +05:30
Jon Dufresne
9c4bd6d5eb Update doc and comment URLs to https where available 2018-06-13 09:00:42 -07:00
Jon Dufresne
4a8f87f4f7 Update Python 2 docs URL to Python 3
Python 3 docs are more actively maintained and are the future of the
project.
2018-06-10 09:40:25 -07:00
Jon Dufresne
13a749de24 Update pypi.python.org URL to pypi.org (#5486)
Was mistakenly reverted in commit
508517f0d7.
2018-06-10 13:06:22 +05:30
Nick Coghlan
f9e9bc155b
Don't double up on the PEP 440 label 2018-06-06 00:10:25 +10:00
Nick Coghlan
2d9356141f
Replace outdated PEP 426 references
PEP 426 was withdrawn, so point to the relevant
accepted PEPs where appropriate.
2018-05-31 21:21:02 +10:00
Benoit Pierre
ca4e2ad6ad improve handling of PEP 518 build requirements
Offload more work to the underlying pip command used to install the
build requirements, so there's no need to duplicate code to handle
environment markers/extras. This is done by setting the correct options
from the finder passed in argument to `_install_build_reqs`.
2018-05-18 23:45:55 +02:00
Donald Stufft
90b3db476f Drop support for Python 3.3 2018-05-17 13:34:48 -04:00
Shlomi Fish
508517f0d7 Fix the capitalization of "GitHub". 2018-05-10 18:18:30 +03:00
Paul Moore
762ae031d2 Merge with master 2018-04-28 10:23:01 +01:00
Paul Moore
f78888b5c1 Add a note to the docs about cosmetic changes in PRs 2018-04-26 19:09:06 +01:00
Pradyun Gedam
47a4eda9d7
Refer to dev-requirements.txt in Testing references 2018-04-26 19:44:10 +05:30
Pradyun Gedam
3738959fb1
Update Automated Testing section 2018-04-26 19:41:43 +05:30
Pradyun Gedam
c05b913e42
Add paragraph about NEWS entry content writing 2018-04-26 19:41:43 +05:30
Pradyun Gedam
dfec2bcbbe
Improve and update instructions for running tests 2018-04-26 19:41:43 +05:30
Pradyun Gedam
5781e3090d
Improve source readablilty by moving links out of prose 2018-04-26 19:41:43 +05:30
Pradyun Gedam
37a29885c7
Rewrap lines 2018-04-26 19:41:43 +05:30
Paul Moore
bad0b13b6a Document our deprecation policy, plus a few other process details 2018-04-24 20:30:23 +01:00
Donald Stufft
dec22c92c2 Switch to CalVer and set a release cadence 2018-04-22 14:21:50 -04:00
Pradyun Gedam
0cbd08a819
Document limitations of current implementation of PEP 518 in pip 2018-04-17 23:10:33 +05:30
Donald Stufft
275ab7c3f5 Switch pip to use Warehouse by default 2018-04-16 15:54:11 -04:00
Paul Moore
cb5d4d2391 encoding argument for open isn't valid in Python 2.7 2018-04-07 11:19:34 +01:00
Paul Moore
ddbbafaabb Fix how docs gets pip version, to work around an issue with readthedocs 2018-04-07 10:57:08 +01:00
Paul Moore
432edcbbc0 Document PEP 518 support 2018-03-14 10:04:47 +00:00
BrownTruck
72f219c410 Add expansion of environment variables in requirement files (#3728) 2018-02-05 16:50:50 +05:30
Mariatta
094afefe26 Quickstart doc: improve the grammar (#4934)
"got elsewhere" sounds odd. Rephrased to: "obtained from elsewhere".

* Add trivial news
2017-12-22 14:55:34 +05:30
Mariatta
6ccb5e1d77 Quickstart doc: lowercase the i in Install. (#4933)
Seems to be more grammatically correct that way.
2017-12-22 14:54:44 +05:30
Cooper Ry Lees
5d951b2a94 Fix git+file example
= When to use this option and was surprised when there was not an example
- Put in a POSIX path in the example with git+file://
2017-12-09 00:39:24 +01:00
Xavier Fernandez
9ff3c18bf2
Merge pull request #4529 from mwilliamson/download-platform-no-deps
Allow download with specific platform and --no-deps
2017-11-17 23:28:16 +01:00
Pradyun Gedam
8f6b4c9b2d Navigation (+other) improvements to Documentation (#4855) 2017-11-12 16:04:37 +00:00
Pradyun Gedam
dfa685548f
docs: fix some indentation issues in quickstart 2017-11-07 12:28:35 +05:30
Oz N Tiram
4370a5a37b Add a global option to disable colors (#4739)
* Add a global option to disable colors

 This is a fix for issue #2449

 All it does is simply add a global option --no-color

 Internally it switches ColorizedStreamHandler to StreamHandler if
 this flag is detected.

* Fix lint errors

 * not sure it makes the code more readable though ...

* Fix typo

* Choose logging class before assigning

 * As requested per review
 * Make the code shorter and easier to follow

* Be polite to followers, add commas

* Add functional test for the --no-color output

* Better detection of windows

* Fix fragile tests - can't trust script --quiet

 * The version found in Travis-CI does not respect this flag
   It added a prefix line and suffix line found if one does not
   add the flag --quiet (script from util-linux 2.26.2).

   As such the out  put is:

     Script started on Fri 27 Oct 2017 07:17:30 AM CEST
     \x1b[31mCannot uninstall requirement noSuchPackage, not installed\x1b[0m\n

     Script done on Fri 27 Oct 2017 07:17:31 AM CEST

  With this change, the test should pass, and is hopefully more stable.

* Simplify testing for color or no-color
2017-11-05 15:23:57 +05:30
Paul Moore
dcf3ac6736 Documentation fixes (#4831)
- Wheel doesn't have a public API
- Reword warning about installing into a running interpreter
2017-11-03 22:30:13 +05:30
Pradyun Gedam
1379aacc98
Add a debugging statement to conf.py 2017-10-20 21:17:32 +05:30
Michael Williamson
c0e07c8418 Update docs for allowing --no-deps with specific platform 2017-10-12 09:30:28 +01:00
Pradyun Gedam
df083c7916 Polish docs and change theme (#4758) 2017-10-07 17:45:27 +01:00
Chris Jerdonek
cf23b06d76 Add a note to the pip-install docs.
This was suggested by @xavfernandez in the review comments.
2017-10-05 02:46:33 -07:00
Pradyun S. Gedam
6feb7979c0 Strip usage in the documentation
This removes a useless empty line in the output.
2017-10-03 22:37:10 +05:30
Eric Hopper
72f677f263 Update supported Mercurial schemes with hg+file (#4357)
Empirically, pip supports pip [-e] hg+file:///path/to/repo
2017-09-30 00:37:45 +02:00
kpinc
e3288bb15c Improve sentence in docs vis passing multiple values in an environment variable (#4677)
* Improve repeated command line options sentence

* Add trivial news entry

* Update user_guide.rst

* Shorten sentence
2017-09-29 23:49:22 +02:00
Paul Moore
4ac223585a Add documentation on how to call pip from user code (#4743)
* Add documentation on how to call pip from user code
* Document the lack of a Python API for pip
2017-09-28 22:15:51 +01:00
Donald Stufft
95bcf8c5f6 Move all internal APIs to pip._internal 2017-08-31 14:53:00 -04:00
Alan Yee
3de4464fab Update installing.rst (#3890)
Various updates to installing.rst
2017-07-27 20:04:04 +01:00
Pradyun S. Gedam
bf4c613071 Add man pages for pip (#4491)
* Add man pages to pip

* 📰
2017-07-05 19:56:13 -04:00
Pradyun S. Gedam
49abd55fe5 Configuration - Documentation updates (#4556) 2017-06-24 13:24:13 -04:00
Paul Moore
8a101321f6 Another attempt to fix encoding issues (#4486)
When reading bytes from subprocesses, use the locale encoding. Don't fail if the data is encoded incorrectly - instead, use the backslashreplace error handler (and warn the user).
2017-05-27 22:02:08 +01:00
Pradyun S. Gedam
375ed4d3fc Switch default upgrade strategy to only-if-needed 2017-05-19 17:09:48 +05:30
Pradyun S. Gedam
fc98e0b524 Fix missing footnote error 2017-05-16 23:48:27 +05:30
Pradyun S. Gedam
e2ff5dcc8c docs: Stop using deprecated attributes 2017-05-16 23:48:15 +05:30
Christian Heimes
041b603704 Example for installation of multiple extras
Documention did not have an example for installation of multiple extras.
To the reader it is not clear if SomePackage[extra1,extra2] works or
SomePackage[extra1] SomePackage[extra2].

(Spoiler alert: Donald told me, it's SomePackage[extra1,extra2].)

Signed-off-by: Christian Heimes <christian@python.org>
2017-04-12 18:17:44 +02:00
Donald Stufft
491294f61e Merge pull request #3721 from gdanielson/patch-1
Update installing.rst example proxy URI
2017-04-03 09:18:39 -04:00
Xavier Fernandez
4581fc7ba4 Fix small docs typos 2017-04-02 18:26:46 +02:00
Donald Stufft
5748d87ab3 Merge pull request #4273 from bitdancer/patch-1
Explain how -e affects pip freeze.
2017-04-01 17:05:23 -04:00
Alex Gaynor
d10e12efa8 Fixed #2394 -- use example.com as a dummy domain 2017-03-22 14:55:05 -04:00
Donald Stufft
45c54b700d Merge pull request #4360 from alex/patch-4
Fixed #1234 -- linkify mailing list
2017-03-22 14:01:27 -04:00
Alex Gaynor
2120f8328f Remove line from docs which refers to the past 2017-03-22 13:01:46 -04:00
Alex Gaynor
62071e28b5 Fixed #1234 -- linkify mailing list 2017-03-22 12:49:49 -04:00
Donald Stufft
90dd13f6a6 Add a special kind of towncrier type for vendored lib updates 2017-03-19 16:49:55 -04:00
Donald Stufft
c36cca51ca Allow marking a change as "trivial" for the news file 2017-03-19 16:39:27 -04:00
Donald Stufft
a45c2f5e24 Generate our NEWS.rst with towncrier 2017-03-19 12:00:31 -04:00
Donald Stufft
59cb562d59 Fix up some bookkeeping 2017-03-18 14:52:14 -04:00
Anish Tambe
85b5b16417 macOS use ~/.config/pip/pip.conf as well (#4100) 2017-03-02 14:14:13 +01:00
Jakub Wilk
4c950500de Fix typos (#4275) 2017-02-10 22:33:50 +01:00
R. David Murray
5e98b44e12 Explain how -e affects pip freeze. 2017-02-09 15:01:38 -05:00
Pradyun S. Gedam
1b0df50f24 Update documentation to mention upgrade-strategy
Follow up on https://github.com/pypa/pip/pull/3972#issuecomment-265374795
2017-01-27 23:27:07 +01:00
David Linke
3945a7fe4e Add documentation for pip check command. 2017-01-22 15:10:36 +01:00
Donald Stufft
c4074c8efd Add a note to the docs about 2.6/get-pip.py (#4095) 2016-11-06 18:48:35 -05:00
Lipis
d86d171364 OS X -> macOS (#4074) 2016-11-06 12:24:43 -05:00
Viktor Szépe
7023acb4bd Typo in pip list docs (#4060)
`pip2 list -o --columns` fails
2016-11-03 18:39:12 -04:00
Simon Pichugin
41dd638803 Add all currently supported git clone forms to docs (#4072) 2016-11-03 18:39:01 -04:00
Cody
dd7df7f303 add how to install extras from direct repo 2016-10-31 15:55:15 +01:00
Xavier Fernandez
aa9d78063a Merge pull request #3742 from ryneeverett/VcsDocClarification
Clarify VCS installation behavior. Resolve #2837.
2016-10-28 10:39:33 +02:00
Sebastian Schaetz
099e849ea5 Update documentation of exists-action 2016-10-18 00:46:45 -04:00
Xavier Fernandez
2856e63cf5 Add --not-required to list command. (#3986) 2016-10-05 14:45:59 +02:00
nvdv
88d2bd8165 Rename --no-deps-only to --not-required. 2016-10-05 15:03:03 +03:00
nvdv
e0b23e9ce3 Update 'pip list' docs and simplify get_no_deps_only method. 2016-09-24 10:45:13 +03:00
c22
aef0254953 Added pip completion support for fish shell. 2016-09-23 09:19:47 +10:00
Xavier Fernandez
5bd3367644 Merge pull request #3760 from patricklaw/pl.pip-install-additional-options
Pl.pip install additional options
2016-08-12 10:27:57 +02:00
Paul Moore
c7e5f52c96 Merge pull request #3858 from cdosborn/master
Make pip show less verbose
2016-07-27 09:47:47 +01:00
Connor Osborn
72b38d875d Update docs/changes/authors for pip show 2016-07-26 18:59:22 -07:00
Patrick Lawson
72d9fd11f4 Doc nits 2016-07-21 13:06:34 -05:00
Patrick Lawson
5337d01502 Remove dead code, remove manylinux reference, fix docs enumeration. 2016-07-21 13:01:52 -05:00
Patrick Lawson
d76477d0b8 Fix docs example enumeration 2016-07-21 13:01:52 -05:00
Patrick Lawson
bbe99ce62d Add --implementation and --abi parameters to `pip download`.
Add thorough tests, usage documentation, and handle some merge issues.
2016-07-21 13:01:52 -05:00
Xavier Fernandez
f5d691a5c8 Merge pull request #3762 from adamchainz/readthedocs.io
Convert readthedocs link for their .org -> .io migration for hosted projects
2016-07-21 13:21:28 +02:00
Xavier Fernandez
af3d485e8e Merge pull request #3816 from IanLee1521/patch-2
Updated documentation copyright year to 2016
2016-07-21 13:18:37 +02:00
Xavier Fernandez
ec8cf5511b Document the get-pip version for 3.2
closes #3510
2016-07-21 10:42:18 +02:00
Ian Lee
b199e687d6 Updated documentation copyright year to 2016 2016-06-24 10:03:57 -07:00
memoselyk
cba9a403c8 Point to setuptools documentation in readthedocs.io 2016-06-05 18:28:35 -05:00
Paul Moore
efc49ebada Clarified when pip is already installed 2016-06-05 15:46:33 +01:00
Xavier Fernandez
b095e41a2a Update docs to reflect the use of master branch (#3774) 2016-06-02 07:14:58 -04:00
Adam Chainz
93e3c8d250 Convert readthedocs link for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-05-29 19:21:28 +01:00
Xavier Fernandez
cd576e66d5 Add some examples to the docs 2016-05-19 15:31:46 +02:00
Xavier Fernandez
4627ef1d14 Merge pull request #3431 from pekkaklarck/patch-1
quickstart: Installing already downloaded package
2016-05-17 17:43:47 +02:00
Pekka Klärck
44e3594608 Fine tuning docs about installing downloaded package
Changed `distribution` to `package` as requested in review commits.
2016-05-17 16:26:42 +03:00
Xavier Fernandez
1d2abae9a1 docs: use autonumbered examples in docs 2016-05-16 21:33:51 +02:00
Douglas Thor
6dcd9dac2e Added --columns, --no-columns option to pip list. Fixes #3651 (#3654) 2016-05-12 13:13:48 -04:00
gdanielson
2b2ca40ccc Update installing.rst example proxy URI
for Install behind a proxy added missing "http://" proxyScheme
2016-04-28 17:40:10 +12:00
ryneeverett
b9602e95cf Merge branch 'develop' into VcsDocClarification 2016-03-31 18:09:14 -04:00
Cory Wright
9959fbeaed Fix typo: Envionment -> Environment 2016-03-05 19:52:28 -05:00
Donald Stufft
c9a5b2bd91 Merge branch 'develop' 2016-03-05 11:55:51 -05:00
Tony Zhaocheng Tan
acea08131b Correct compatible release clause example
According to PEP 0440, ~= V.N is the same as >= V.N, == V.* , not >= V.N, == V.N.*

https://www.python.org/dev/peps/pep-0440/#compatible-release
2016-03-01 21:01:11 -05:00
Stéphane Bidoul (ACSONE)
a8804b4adb Update documentation re subdirectory option 2016-02-18 18:27:35 +01:00
jwg4
241359564a Add a warning about order of processing requirements.
As per https://github.com/pypa/pip/issues/3480#issuecomment-183010917 there is no guarantee over the order in which items in a requirements.txt file might be installed.
2016-02-11 19:10:13 +00:00
Xavier Fernandez
4e586d3297 docs: fix some typos 2016-02-07 00:11:45 +01:00
Anton Ovchinnikov
f5b2d3e81d Fix example package name in user_guide.rst 2016-02-05 21:30:34 +01:00
Pekka Klärck
ba3a20e8b6 quickstart: Installing already downloaded package
Document how to install a package if the target machine has no network connection.
2016-01-28 23:17:47 +02:00
Jon Banafato
de35a30eed Correct installation hash checking docs
The docs currently show passing a package's hash(es) in the form of
``--hash:sha256=...``. When trying to install something using this
format, pip fails with the error ``pip: error: no such option:
--hash:sha256``. This should be changed to match the output of ``pip
hash``.
2016-01-28 12:07:55 -05:00
Cass
0c553e34ee Fix typo in the user guide doc 2016-01-27 22:54:24 -05:00
Christopher Snyder
062ee49f30 Fix typo in the install doc 2016-01-22 08:47:20 -05:00