Commit Graph

85 Commits

Author SHA1 Message Date
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
Erik Rose 4f6737407b Correct the level of the Wheel Cache heading.
Previously, Hash Verification, Editable Installs, Controlling setup_requires, and Build System Interface were all getting placed under it.
2015-10-07 16:31:41 -04:00
Marcus Smith b9095440c9 add comment about the order of requirements file preprocessing 2015-10-03 21:30:26 -07:00
Marcus Smith 0ac55a06f5 Merge pull request #2929 from dougthor42/develop
Add example requirements.txt file to pip_install.rst
2015-09-17 09:47:18 -07:00
Douglas Thor 91f0e8b291 Removed example file section for external/unverified packages
[ci skip]
2015-09-17 09:43:27 -07:00
Douglas Thor 950009031f Updated pip_install.rst to reflect comments made by @qwcode
[ci ckip]
2015-09-16 15:04:51 -07:00
Marcus Smith 9259e2e66b refactor the "Fast & Local Installs" section to "Installing from local
packages".  With pip's index caching, and wheel caching,  the motivation
to find a way to speed up pip is not as pressing anymore, although it is
still true that people may need a local-only install for certain cases.
2015-09-10 21:30:38 -07:00
Marcus Smith dfcd9f9127 Merge pull request #3083 from qwcode/update_install_docs
updated install instructions (minus linux updates)
2015-09-07 19:00:10 -07:00
Marcus Smith 697178e3fc - a new "Do I need to install pip?" section
- a new subsection for the get-pip options
  (which now mentions --no-wheel and --no-setuptools)
- explain that get-pip.py installs setuptools and wheel, and why.
- mention support for Python3.5
2015-09-07 16:56:10 -07:00
Xavier Fernandez 9d4566ab5a Merge pull request #2949 from inirudebwoy/patch-1
Add more info about subdirectory component of path in docs
2015-09-03 22:46:56 +02:00
Donald Stufft 0f5d4286a5 Deprecate and Noop the PEP 438 functionality due to PEP 470 2015-09-02 23:47:05 -04:00
tim smith 447166e9e5 Grammar nits
"it's" always expands to "it is" and is never possessive
2015-08-19 23:13:53 -07:00
Kit Randel 8325c439b8 Provide link to constraints documentation. 2015-08-03 10:40:12 +12:00
Michael Klich bbe29b20c9 Add more info about subdirectory component of path
Subdirectory component was only mentioned in examples, and it's usage was not clear enough.
2015-07-02 10:53:47 +01:00
Douglas Thor bc758193a0 Added example requirements file.
[ci skip]
2015-06-24 16:07:25 -07:00
Douglas Thor 735367347f Update pip_install.rst
[ci skip]
2015-06-24 15:59:58 -07:00
Douglas Thor 50fe1ad62d Update pip_install.rst
[ci skip]
2015-06-24 15:58:10 -07:00
ryneeverett 5c688df862 Clarify VCS installation behavior. Resolve #2837. 2015-06-03 06:33:06 -04:00
Robert Collins bb0b429a49 Issue #2731: Constraints files.
This adds constraints files. Like requirements files constraints files
control what version of a package is installed, but unlike
requirements files this doesn't itself choose to install the package.
This allows things that aren't explicitly desired to be constrained if
and only if they are installed.
2015-06-03 06:38:33 +12:00