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
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
3c753c5a86
Move get-pip.py to its own repository
2016-01-20 08:53:45 -05: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
Xavier Fernandez
5fd27e8c6c
Clarify our policy on python patch versions support
...
addresses issue #3074
2016-01-08 00:22:09 +01:00
Matt Iversen
d51a4b345b
Merge pull request #3320 from techtonik/patch-3
...
Fix failing doc test due to expired certificate - use www.pypa.io
2015-12-31 01:51:49 +11:00
anatoly techtonik
6da89f1922
Fix failing Travis tests due to expired certificate
...
https://travis-ci.org/pypa/pip/jobs/96488586#L146
2015-12-27 15:02:59 +03:00
Ville Skyttä
0da18e93b3
Spelling fixes
2015-12-27 00:58:23 +02: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
9e5e34e9f7
Add --algorithm flag to pip hash
.
2015-10-12 14:05:10 -04:00
Erik Rose
76983f363a
Restore documentation about alternate hash algorithms in URLs.
2015-10-12 12:09:49 -04:00
Erik Rose
f35ce75025
Make "installation bundles" less of an official term.
2015-10-11 09:17:40 -04:00
Erik Rose
3824d735a0
Revise what hashes protect you against.
...
We don't need to talk about the network, since HTTPS should ensure transmission integrity. We do need to watch out for the CA chain. Stop mentioning the CDN because it's a deep hole: we might as well mention Rackspace and Amazon and who knows who else.
2015-10-10 22:44:12 -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
Donald Stufft
b11cb019a4
Drop support for Python 3.2
2015-10-01 09:36:16 -04:00
Marcus Smith
a4f7bc62c2
Merge pull request #3152 from James-Firth/patch-1
...
Fixed broken link to article comparing setup.py to requirements.txt (remade)
2015-09-30 12:11:10 -07:00
James Firth
fa4be0f53d
Fixed broken link to article comparing setup.py to requirements.txt
2015-09-30 11:32:24 -05:00
Marcus Smith
9dcfc887ee
for linux package mgr instructions, link to the new PyPUG section
2015-09-23 16:58:20 -07:00
Marcus Smith
57a5ebb9b2
link to the python.org location for the PyPUG
2015-09-23 16:57:51 -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
Mathew Jennings
417f79d8b8
Add pip download
command and deprecate pip install --download
.
...
`pip download` has the same functionality as `pip install --download`,
and the behavior of `pip install --download` is preserved with a deprecation
warning. `pip install --download` will be removed in pip version 10.
2015-09-13 17:41:00 -04:00
Marcus Smith
eca8283bb5
remove the "by a tool like"
2015-09-11 20:27:26 -07:00
Marcus Smith
c5664a8470
mention that pre-installed pip needs to be upgraded
2015-09-11 20:24:44 -07:00
Marcus Smith
04a175e6fc
- instead of saying "may", explain when that's true
...
- simpler, more direct wording
2015-09-11 20:17:36 -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
Donald Stufft
7d69501fcb
Merge pull request #2820 from j0057/config-docs
...
Document behavior of boolean config file variables (--no-cache and --no-compile)
2015-06-23 19:11:22 -04:00
ryneeverett
5c688df862
Clarify VCS installation behavior. Resolve #2837 .
2015-06-03 06:33:06 -04:00
Joost Molenaar
85a1036836
Document surprising pip configuration behavior
2015-06-03 06:22:01 +02: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
Robert Collins
1d04615a37
Tweak requirement file documentation.
...
We're actually pinning down a fairly specific grammar now, so lets
make it official. All options are at the end, and only options get
quoting. I've also tweaked some of the existing examples to make the
existing grammar features (that I know people use) clearer - like
spaces between requirements and version specifiers.
2015-06-02 07:15:42 +12:00
Marcus Smith
1afd2e8494
docs updates related to environment markers
2015-06-02 06:50:16 +12:00
Marcus Smith
1a083514fc
intersphinx to PyPUG and pypa.io
2015-06-02 06:50:16 +12:00
Donald Stufft
3569a9b060
Remove the implicit debug log
2015-05-21 18:01:40 -04:00
Razzi Abuissa
70c6db627b
Fix typo
2015-05-09 19:39:55 -04:00
Marcus Smith
b1cab1e31b
docs and changelog about marker parsing changes
2015-05-09 14:43:35 -07:00
Donald Stufft
18064e7017
Remove the workarounds/hacks to handle distribute -> setuptools
2015-05-09 15:09:05 -04:00
Robert Collins
6aec23cafe
Issue #2675 : Granular control over wheels/sdists
...
With wheel autobuilding in place a release blocker is some granular
way to opt-out of wheels for known-bad packages. This patch introduces
two new options: --no-binary and --only-binary to control what
archives we are willing to use on both a global and per-package basis.
This also closes #2084
2015-04-24 08:52:48 +12:00
Donald Stufft
bd39f99f4f
Merge pull request #2714 from mkohler/repeatability_caveat
...
Add setup_requires caveat to repeatability section.
2015-04-22 20:43:05 -04:00
Mark Kohler
ee0f460f02
Add setup_requires caveat to repeatability section.
2015-04-22 16:00:14 -07:00
Robert Collins
f76dab1a52
PyPI is less broken now. Update docs.
2015-04-23 09:58:49 +12:00
Robert Collins
62041d3ca8
Cleanup now use_wheel is the default.
...
There were a bunch of tests passing use_wheel unnecessarily, this
makes the change to remove use_wheel larger than it needs to be.
2015-04-20 20:12:03 +12:00
Robert Collins
0e57ebc008
Make adding options be just function calls.
...
The .make is just sugar for 'call a function' that gets in the way of
just having functions.
2015-04-17 15:04:25 +12:00
Robert Collins
08acb6670d
Issue #2140 : Build wheels automatically
...
Building wheels before installing elminates a cause of broken environments -
where install fails after we've already installed one or more packages.
If a package fails to wheel, we run setup.py install as normally.
2015-04-13 18:33:07 +12:00
Robert Collins
4926409340
Issue #2563 : Read cached wheels from ~/.cache/pip
...
This won't put wheels into that directory, but will read them if they
are there. --no-cache-dir will disable reading such wheels.
2015-04-13 18:33:07 +12:00
Georgi Valkov
0da51b14d7
Remove misleading test cases and improve docs
2015-04-12 23:52:49 +02:00
Georgi Valkov
29f0c75c63
Do not shlex.split() and flatten value of global|install_options
2015-04-12 23:52:49 +02:00
Georgi Valkov
4a70730617
Replace all occurrences of install|global-options with install|global-option
2015-04-12 23:52:49 +02:00
Georgi Valkov
b014668b30
Add --install-options and --global-options to the requirements file parser
...
This allows lines such as the following to exist in requirements files:
INITools==0.2 --install-options="--prefix=/opt"
virtualenv>=1 --global-options="--no-user-cfg"
In addition, the requirements file parser was overhauled with simplicity
and clarity in mind.
2015-04-12 23:52:49 +02:00
Donald Stufft
1d58e09588
Merge pull request #2645 from techtonik/patch-3
...
pip_install.rst: Fix backslashes in Windows path
2015-04-07 05:39:31 -04:00
Marcus Smith
6d839e2b14
Note that the current cycle handling is not a promise, and that broken environments are still possible.
2015-04-02 21:12:52 -07:00
Marcus Smith
30ea101678
more explanation of the install order
2015-04-01 21:21:19 -07:00
Marcus Smith
dd27b19c1b
fix broken section anchor
2015-04-01 16:57:15 -07:00
Robert Collins
17352765f0
Issue #2478 - topological install order.
...
This is needed for setup-requires, since without it its possible
to cause installation to fail in sort-circuit scenarios such as
the added functional test case demonstrates.
2015-04-01 12:33:17 +13:00
Eric Hanchrow
b3c73c32a0
Update user_guide.rst
...
Fix typo: the example at the end is for _installing_ a bundle, not _uninstalling_ it
2015-03-22 17:03:04 -07:00
anatoly techtonik
6b28be6a76
pip_install.rst: Fix backslashes in Windows path
2015-03-18 15:41:10 +03:00
Kyle Persohn
a57f31beba
Update user_guide.rst
2015-03-16 15:30:13 -05:00
Bence Nagy
ea01415b8b
Disable sphinx's smartypants to fix -- being replaced with – in docs
2015-03-13 14:45:10 +01:00
Marc Abramowitz
f4ee579304
test_freeze_svn: No dep on bitbucket
...
Instead of using local_checkout, which downloads a 204 KB dump file from
http://bitbucket.org/hltbra/pip-initools-dump/raw/8b55c908a320/INITools_modified.dump ,
use `svnadmin create` and `svn import` to create an svn repo on the fly.
2015-03-11 10:26:35 -07:00
Donald Stufft
9981efdd89
Merge pull request #2302 from dstufft/document-cache
...
Document the default cache directories
(cherry picked from commit ef4b0a9bed
)
2015-01-03 01:09:01 -05:00
Donald Stufft
e65a22cd4f
Document the default cache directories
2015-01-02 23:14:17 -05:00
Donald Stufft
15ab56dc14
Update the documentation to reflect the current release process
2014-12-23 09:43:46 -05:00
Marc Abramowitz
e3ada1280b
Update installing.rst
...
Resolve merge conflict on updating on Windows.
2014-12-23 07:39:13 -05:00
Marc Abramowitz
a19e6dd308
Update installing.rst
...
Resolve merge conflict on updating on Windows.
2014-12-22 20:50:21 -08:00
Donald Stufft
7b4be2bc3e
Merge branch 'develop'
...
Conflicts:
docs/installing.rst
docs/reference/pip_install.rst
2014-12-22 11:20:01 -05:00
Donald Stufft
5f5ebe8259
Document an alternative to pip bundle
2014-12-20 19:08:33 -05:00
Bussonnier Matthias
0582a91e62
Do not shadow submodules
...
using object that have the same name as submodules as the weird effect
of makeing `import pip.commands.<something> as <anothername>` fail with
a key error. This fixes it by renamin commands as command_dict and fixin
a few imports to accomodate.
Related to #2149
2014-12-12 16:06:04 +01:00
Jan Pokorný
859acf124d
doc/install: fix typo in "from repo subdir" example
...
Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
2014-12-09 22:00:31 +01:00
jarondl
b974eadd9d
DOC: pip is sometimes included with Python
2014-12-08 14:15:12 +02:00
Victor Stinner
e498d83db1
Support markers in requirements
...
It's now possible to specify requirements markers in requirements.
Examples::
futures; python_version < '2.7'
mock; python_version < '3.3'
nose
ordereddict; python_version < '2.7'
unittest2; python_version < '2.7'
The separator is "; ". For convinience, ";" alone is also supported, but
no in URLs. The ";" character is a legit and common character in an URL.
Example of valid URL without markers::
http://foo.com/?p=bar.git;a=snapshot;h=v0.1;sf=tgz
Example of URL with markers::
http://foo.com/?p=bar.git;a=snapshot;h=v0.1;sf=tgz ; python_version < '3.3'
2014-11-20 10:52:08 -05:00
Chris Jerdonek
c9c69ed052
Update docs to explain the "version" component of the egg name.
2014-10-01 07:14:49 -04:00
Donald Stufft
0e96b1af4b
Switch versioning from X.Y.Z to X.Y dropping the leading 1
2014-09-17 22:05:31 -04:00
Donald Stufft
d91e0d9e20
Clarify the requirements file format documentation - Thanks @thanatos
2014-09-11 09:53:30 -04:00
Donald Stufft
f63d1e3abb
Implement platform specific user config locations
2014-09-10 11:43:34 -04:00
Donald Stufft
767d11e49c
Switch to using the stdlib logger instead of pip.log
2014-09-10 09:36:09 -04:00
anatoly techtonik
aef9dccc92
docs: there are also independent package managers
2014-09-07 22:52:00 +03:00
Marcus Smith
743fb9efcc
describe "non-recursive" as "only if needed recursive"
2014-08-24 10:48:36 -07:00
Richard Jones
aedca3c842
Implement site-wide configuration settings
...
* add site_config_dirs() to appdirs to determine locations across OSes
* add system_config_files to locations.py
* add system_config_files to get_config_files() and re-order files entries to correct precedence
* document changes to configuration files in user guide
Closes #309
2014-08-22 14:26:41 +10:00
Richard Jones
79c0176f12
Remove unnecessary duplicate reference
...
Fixes issue #1972
2014-08-13 12:24:55 +10:00
Donald Stufft
90688e82b1
Revert "Merge pull request #1519 from dstufft/remove-dependency-links"
...
This reverts commit da02f073da
, reversing
changes made to 2ad8888901
.
Conflicts:
CHANGES.txt
pip/commands/freeze.py
pip/commands/list.py
pip/commands/wheel.py
pip/index.py
pip/req/req_set.py
pip/vcs/subversion.py
2014-08-01 16:50:08 -04:00
Matt Iversen
fcdde73e9f
Merge pull request #1627 from techtonik/develop
...
Update sphinx-generated doc build files
2014-08-01 21:19:23 +10:00
Marcus Smith
6adbab3d9e
break out the examples so we can add a qualifying footnote for --user installs
...
Conflicts:
docs/installing.rst
2014-07-21 20:51:44 -07:00
Marcus Smith
24952b32d3
get-pip.py option examples
...
Conflicts:
docs/installing.rst
2014-07-21 20:47:24 -07:00
Donald Stufft
bb6c11ed17
Merge pull request #1848 from daviewales/clarify-documentation
...
Clarify requirement specifier format
2014-06-25 23:47:14 -04:00
patricktokeeffe
bd47689075
Add note about updating system path
...
Remind users to update system path since script does not.
Well, at least on Windows it doesn't update PATH. Perhaps this should be qualified?
2014-06-19 14:27:22 -07:00
Jyrki Pulliainen
2f5b0449ad
Document the --no-use-wheel in requirements.txt
2014-06-10 15:36:20 +02:00
David Wales
91eb30195f
Clarify requirement specifier format
...
If you use single or double quotes in a `requirements.txt` file, pip exits with an error. This change clarifies that single or double quotes should only be used in the shell.
2014-05-31 00:02:00 +10:00
Donald Stufft
52ca02608e
Use CacheControl instead of custom cache code
...
* Deprecates the --download-cache option & removes the download
cache code.
* Removes the in memory page cache on the index
* Uses CacheControl to cache all cacheable HTTP requests to the
filesystem.
* Properly handles CacheControl headers for unconditional
caching.
* Will use ETag and Last-Modified headers to attempt to do a
conditional HTTP request to speed up cache misses and turn
them into cache hits.
* Removes some concurrency unsafe code in the download cache
accesses.
* Uses a Cache-Control request header to limit the maximum
length of time a cache is valid for.
* Adds pip.appdirs to handle platform specific application
directories such as cache, config, data, etc.
2014-05-09 18:28:20 -04:00
Donald Stufft
a4fec67bba
Merge branch 'master' into develop
...
Conflicts:
.travis.yml
CHANGES.txt
PROJECT.txt
README.rst
docs/installing.rst
pip/__init__.py
pip/_vendor/vendor.txt
setup.py
tox.ini
2014-05-03 02:37:03 -04:00
Donald Stufft
0e72f65bf4
Merge branch '1.5.X'
...
Conflicts:
.travis/py34.sh
CHANGES.txt
PROJECT.txt
2014-05-03 01:13:28 -04:00
Donald Stufft
8d0741a0d2
Update documentation to point at the new bootstrap location
2014-05-02 18:55:39 -04:00
Marcus Smith
5adf82b7e7
consistent location for new build interface docs
2014-04-25 22:20:53 -07:00
Alex Gaynor
690ce3e839
Use the real URL, raw.github is just a redirect these days
...
And some tools don't follow redirects by default.
2014-04-25 12:58:51 -07:00
Marcus Smith
530fc97193
break out the examples so we can add a qualifying footnote for --user installs
2014-04-09 16:53:52 -07:00
Marcus Smith
0867816811
get-pip.py option examples
2014-04-08 22:57:22 -07:00
Florian Briand
4691a9e8b7
Fix conjugation and line length
2014-04-08 22:38:23 -07:00
Florian Briand
60b3579cf8
Add information about command line option
...
... which can be used with get-pip.py
2014-04-08 22:38:12 -07:00
Dav Clark
a77bd6c64b
Note --build-option
only available in pip wheel
...
I got a little confused, per issue #1707 .
2014-04-05 11:03:05 -07:00