Commit Graph

127 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
Alex Gaynor 2120f8328f Remove line from docs which refers to the past 2017-03-22 13:01:46 -04:00
R. David Murray 5e98b44e12 Explain how -e affects pip freeze. 2017-02-09 15:01:38 -05:00
David Linke 3945a7fe4e Add documentation for pip check command. 2017-01-22 15:10:36 +01: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
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
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
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
memoselyk cba9a403c8 Point to setuptools documentation in readthedocs.io 2016-06-05 18:28:35 -05:00
Xavier Fernandez cd576e66d5 Add some examples to the docs 2016-05-19 15:31:46 +02: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
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
Donald Stufft 1ae7707e96 Default to downloading to the current directory 2016-01-19 13:05:34 -05: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