Commit Graph

103 Commits

Author SHA1 Message Date
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
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
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
Donald Stufft 275ab7c3f5 Switch pip to use Warehouse by default 2018-04-16 15:54:11 -04:00
BrownTruck 72f219c410 Add expansion of environment variables in requirement files (#3728) 2018-02-05 16:50:50 +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
Pradyun Gedam 8f6b4c9b2d Navigation (+other) improvements to Documentation (#4855) 2017-11-12 16:04:37 +00: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
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
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
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
R. David Murray 5e98b44e12 Explain how -e affects pip freeze. 2017-02-09 15:01:38 -05:00
Lipis d86d171364 OS X -> macOS (#4074) 2016-11-06 12:24:43 -05: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
memoselyk cba9a403c8 Point to setuptools documentation in readthedocs.io 2016-06-05 18:28:35 -05:00
Xavier Fernandez 1d2abae9a1 docs: use autonumbered examples in docs 2016-05-16 21:33:51 +02:00
ryneeverett b9602e95cf Merge branch 'develop' into VcsDocClarification 2016-03-31 18:09:14 -04: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
Xavier Fernandez 4e586d3297 docs: fix some typos 2016-02-07 00:11:45 +01: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
Emil Styrke a2cea0eb7d Fix typo
It seems the requirement specifier must be `sys_platform` and not `sys.platform`. Tested with pip 8.0.0.
2016-01-21 09:44:50 +01:00
Paul Moore 106eb628a2 Fix reference to #egg syntax to avoid implying that setting the version works 2016-01-18 10:14:13 +00:00
Paul Moore 2fcfd9320b Docs - pip install - a bit more detail on how pip processes requirements 2016-01-15 15:55:48 +00:00
Paul Moore 7a90ee23ff Add an explanation about how packages are located for install 2015-12-11 17:59:34 +00:00
Donald Stufft f39bc756e5 Merge branch 'develop' into hashes2 2015-11-06 18:46:09 -05:00
Xavier Fernandez 034ac608a2 Merge pull request #3223 from xavfernandez/improve_subdirectory_docs
Improve subdirectory docs
2015-11-05 23:52:50 +01:00
Marcus Smith 9d921b51e0 fix broken link to old pypa.io section 2015-11-05 14:31:12 -08:00
Xavier Fernandez e2c9a0f743 add basic example for subdirectory
closes #2457
2015-11-03 22:56:39 +01:00
Xavier Fernandez 8e22a94f41 docs: add quotes to subdirectory example
To fix potential bash issue
closes #3221
2015-11-03 21:07:54 +01:00
Erik Rose 4488047ef6 Update the wheel-cache-disabling docs with our latest understanding of C compiler nondeterminism. 2015-10-21 16:35:30 -04:00
Erik Rose f38fc903f2 Obey --require-hashes option in requirements files.
Removed the mention of "package index options" in the docs, because they don't all fit that category anymore. Not even --no-binary and --only-binary do; they're "install options".
2015-10-21 16:02:47 -04:00
Erik Rose ee9d6fb2c3 Modernize recommendations to not call setuptools-level things directly. 2015-10-19 23:40:00 -04:00
Erik Rose 925e4b4466 Fix false hash mismatches when installing a package that has a cached wheel.
This would occur when, for example, installing from a requirements file that references a certain hashed sdist, a common situation.

As of pip 7, pip always tries to build a wheel for each requirement (if one wasn't provided directly) and installs from that. The way this was implemented, InstallRequirement.link pointed to the cached wheel, which obviously had a different hash than the index-sourced archive, so spurious mismatch errors would result.

Now we no longer read from the wheel cache in hash-checking mode.

Make populate_link(), rather than the `link` setter, responsible for mapping InstallRequirement.link to a cached wheel. populate_link() isn't called until until prepare_files(). At that point, when we've examined all InstallRequirements and their potential --hash options, we know whether we should be requiring hashes and thus whether to use the wheel cache at all.

The only place that sets InstallRequirement.link other than InstallRequirement itself is pip.wheel, which does so long after hashes have been checked, when it's unpacking the wheel it just built, so it won't cause spurious hash mismatches.
2015-10-19 23:40:00 -04:00
Colin Watson 4a67f40a41 Fix example of using setuptools find_links
setuptools.package_index.local_open is used for file: URLs, and only
handles directories if the URL ends with a slash.  Add the trailing
slash to pip's documentation to reduce confusion.
2015-10-16 05:20:03 +01:00
Erik Rose 76983f363a Restore documentation about alternate hash algorithms in URLs. 2015-10-12 12:09:49 -04:00
Erik Rose 6f828c351f Correct and clarify docs and comments. 2015-10-10 22:44:12 -04:00
Erik Rose 7a0a97c081 Merge 'develop' into 'hashing' to bring the latter up to date. 2015-10-08 13:37:19 -04:00
Erik Rose d477ae6c5c Add warning about `python setup.py install`. 2015-10-08 00:36:14 -04:00
Erik Rose 09008bf190 Add `pip hash` command. 2015-10-08 00:36:03 -04:00
Erik Rose 14506f8261 Document hash-checking mode. 2015-10-07 16:35:27 -04:00