Sumana Harihareswara
f6a4c71c95
WIP fixing errors
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
165e5a33ff
WIP reorganizing
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
c03335502a
WIP formatting of source section
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
7e51405806
WIP reformatting as nested list
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
8f2d28b563
WIP to squash
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
7662d840ed
Polish formatting and wording
2019-08-13 19:21:01 -04:00
Sumana Harihareswara
4b8ecd6f2d
Add architecture overview.
2019-08-13 19:21:01 -04:00
Vinicyus Macedo
16af35c613
Adding improvements to the _get_path_to_url function
2019-08-12 14:32:03 -03:00
Pradyun Gedam
7c319ad74a
Add a skeleton for architecture documentation ( #6836 )
2019-08-07 02:41:00 +05:30
Pradyun Gedam
5280483c06
Clarify who we welcome help from
2019-08-07 02:40:08 +05:30
Paul Moore
e4c32b9917
Merge pull request #6770 from omry/master
...
exclude '.tox', '.nox' from being copied during 'pip install .'
2019-08-05 23:29:02 +01:00
Pradyun Gedam
1429a55f40
Add a skeleton for architecture documentation
2019-08-05 17:51:28 +05:30
Omry Yadan
6dd5727773
responded to comments
2019-08-03 11:14:36 -07:00
Omry Yadan
ec47c866c8
updated docs
2019-08-03 10:31:42 -07:00
Chris Jerdonek
1f09e67f34
Only import a Command class when it is actually needed.
...
This resulted in an approximate 24% speed-up of a vanilla `pip`
invocation on one system (0.477 secs before, 0.363 secs after).
2019-07-26 23:30:26 -04:00
Pradyun Gedam
8de817c7ed
Reword as suggested in PR review
2019-07-20 09:37:48 +05:30
Pradyun Gedam
6057e6c344
Document how Python 2.7 support will be handled
2019-07-20 09:37:47 +05:30
Xavier Fernandez
ab10b8c328
debug: add warnings about its provisional status
2019-07-18 14:39:12 +02:00
Xavier Fernandez
d70edc8a95
docs: add basic documentation for pip debug
2019-07-18 14:39:12 +02:00
Xavier Fernandez
8f45aee97a
Fix line length & don't flake8 docs in python 2
2019-07-18 14:37:31 +02:00
Eli Schwartz
1350b95dee
docs: fix manpage generation
...
This was broken in commit 20f672c4e6
,
which reorganized the conf.py file into the html subdirectory. See:
https://github.com/pypa/pip/pull/5724
https://github.com/readthedocs/readthedocs.org/issues/1543
This broke the relative manpage globbing because Sphinx will os.chdir()
into the directory location of conf.py before evaluating it, so the
globbing returned nothing at all. As a result, while the main pip(1)
manpage continued to be built, no pip-*(1) subcommand manpages were
built.
2019-07-17 23:53:50 -04:00
Eli Schwartz
f2cbcd190f
docs: check that the subcommand manpages are actually found and being used
2019-07-17 23:52:44 -04:00
Eli Schwartz
f3f63c0f82
docs: fix manpage names being truncated
...
In commit d2e7377c0f
, the documentation
directories were reorganized, resulting in `fname_base` (the path that
Sphinx looked for source files) to no longer expect the leading 'man/'.
This was always also stripped from the `outname`, which now strips four
characters twice over.
Fix by reducing the stripped length to only the length of the prefix in
fname_base itself.
2019-07-17 22:53:17 -04:00
Hugo
2c1010ee96
Drop support for EOL Python 3.4
2019-07-07 11:45:16 +03:00
Pradyun Gedam
a8c66dc5d7
Merge pull request #6007 from smartsammler/fix-iss4733
...
Fix #4733 by deleting the failing example
2019-07-06 09:18:58 +05:30
Pradyun Gedam
f196814b71
Soften language in note for Installation Order
2019-06-16 19:34:19 +05:30
Pradyun Gedam
3c17e280f5
Add another colon to make it ReST directive
2019-06-16 18:27:00 +05:30
Pradyun Gedam
61c4b6159c
Add a disclaimer to the "Installation Order" section ( #6604 )
2019-06-16 17:43:28 +05:30
Pradyun Gedam
cbb2a5e6ad
Add a disclaimer to the "Installation Order" section
...
This section has caused a lot of user confusion since PEP 517/518. It seems that users are referring to this section for advice about how to deal with build time issues, which contains statements that do not hold true for build requirements.
2019-06-13 16:57:07 +05:30
Chris Jerdonek
d72758394d
Fully support --trusted-host inside requirements files.
2019-06-13 01:21:05 -07:00
Abhinav Sagar
107258da0b
Document issue tracker triage as a contribution area ( #6569 )
2019-06-05 06:36:32 +05:30
Stéphane Bidoul (ACSONE)
99b64ba80f
docs: mention installing from git refs
2019-05-18 12:02:28 +02:00
ABHYUDAY PRATAP SINGH
a731e7e37d
Docs: capitalize "URL"
2019-05-10 22:52:21 +02:00
Pulkit Goyal
d2742a9049
Improve sentence about PyPI package search ( #6476 )
2019-05-07 14:30:39 -04:00
Chris Jerdonek
a163ae5af1
Fix some formatting issues in the pip-install docs ( #6432 )
2019-05-07 09:13:56 -04:00
Albert Tugushev
7130b1d0e0
Fix option name for smart quotes in sphinxdoc conf ( #6422 )
...
Also configure the smartquotes_action to exclude dashes from transformation.
See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes
2019-04-21 09:51:42 -07:00
Caleb Martinez
ac9010e87c
Allow adding a custom string to pip's User-Agent via an environment variable ( #5550 )
2019-03-31 02:37:02 -07:00
Pi Delport
5f3c56e188
Fix some typos
2019-03-12 21:54:18 +01:00
jakirkham
9360648b34
Remove extra .
2019-02-28 13:10:24 -05:00
Pradyun Gedam
45d16ac83e
Remove note about flake8 noqa comments
2019-02-25 22:10:00 +05:30
Nick Coghlan
682cff7230
Fix #6163 : Default to setuptools.build_meta:__legacy__
...
The main setuptools PEP 517 backend is intended for
explicit usage in `pyproject.toml`, when the project
authors can ensure that their `setup.py` runs without
that directory being implicitly on `sys.path`.
For implicit usage, setuptools now offers a separate
legacy backend that more closely mimics direct
execution of the `setup.py` script.
2019-02-06 20:57:57 +10:00
Pradyun Gedam
98654c8761
Replace link to virtualenv-users with Discourse Packaging channel
2019-01-29 14:09:47 +05:30
Thea Flowers
dc5c13d547
Address comments
2019-01-28 10:05:23 -08:00
Thea Flowers
f7d84b117e
Update index
2019-01-25 11:27:55 -08:00
Albert-Guan
465261a828
Document that empty environment variables are not treated as false ( #5953 )
2018-11-24 19:30:41 +05:30
Donald Stufft
51eb885e78
Add a release task to upgrade CPython's bundled pip
2018-11-19 07:39:10 -05:00
Paul Moore
3a77bd667c
Merge pull request #5743 from pfmoore/pep517
...
PEP 517 implementation
2018-11-15 09:32:17 +00:00
Paul Moore
cf4d84e58f
Address doc review comments
2018-11-14 13:15:55 +00:00
Pradyun Gedam
507b90e117
Merge pull request #5949 from kynan/extend-docs
...
Add instructions for running pip from source to docs
2018-11-13 21:21:43 +05:30
Julian Gethmann
f92ac73ccd
Fix pypa#4733 by changing the failing example
...
This example did not make sense unless it was possible to install specify a
version of a package one installs referencing by the path (here: `.`).
A new example for the local installation with an extra has been added
instead.
2018-11-12 17:08:45 +01:00
Paul Moore
4ca38e0c38
Merge with master
2018-11-11 13:49:35 +00:00
Pradyun Gedam
9bb184d1f2
Fix line-too-long linter message
2018-11-08 12:35:05 +05:30
Xavier Fernandez
38298779a1
Merge pull request #5986 from Albert-Guan/ISSUE5984
...
Issue5984
2018-11-07 10:50:51 +01:00
xtreak
3ee456033c
Change download example to use --destination-directory
2018-11-05 11:00:01 +00:00
albertg
1e654ad038
add command name for reference documents
2018-11-04 16:03:11 -05:00
xtreak
0900b4c3ff
Fix pip download example in usage
2018-11-01 17:58:48 +00:00
Pradyun Gedam
ca848a5068
Merge pull request #5958 from pradyunsg/docs/vendoring-info-from-docs
...
Include the Vendoring policy in the docs
2018-10-30 10:45:45 +00:00
Paul Moore
a4c7d7d996
Add documentation
2018-10-29 23:33:21 +01:00
Florian Rathgeber
b911f65365
Remove mention of virtualenv
2018-10-28 23:48:19 +00:00
Florian Rathgeber
044fdda942
Switch to running src/pip now #5481 is merged
2018-10-28 14:22:59 +00:00
Florian Rathgeber
afe41d4c07
And some notes and caveats
2018-10-28 14:20:02 +00:00
Florian Rathgeber
8e9ef24ae4
Add instructions for running pip from source to docs
2018-10-28 14:20:02 +00:00
Pradyun Gedam
bc9c51292a
Include the Vendoring policy in the docs
2018-10-28 11:27:28 +00:00
AceGentile
69037caa0c
remove egg version from pip install command reference
...
fix #5888
2018-10-27 12:51:57 +02:00
Pradyun Gedam
e19aceff40
Merge branch 'master' into appveyor-rename
2018-10-23 19:20:46 +05:30
Pradyun Gedam
06ccf39bc3
Merge pull request #5814 from pradyunsg/docs/reduce-heading-level
...
Reduce the heading level
2018-10-22 12:31:15 +05:30
Pradyun Gedam
5167495eb7
Rename appveyor.yml -> .appveyor.yml and update references
2018-10-22 12:16:43 +05:30
Benoit Pierre
83b879b1ec
Improve PEP 518 build isolation ( #5824 )
...
Handle .pth files, so namespace packages are correctly supported under Python 3.2 and earlier, and more.
2018-10-16 12:04:28 +05:30
Pradyun Gedam
dbf758a514
Reduce the heading level
2018-09-26 11:29:19 +05:30
Donald Stufft
3065bea8f9
get-pip.py is mostly a giant base85'd blob and can't be reviewed
2018-09-24 16:37:33 -04:00
Pradyun Gedam
20f672c4e6
Move conf.py into the html directory, to be compatible with RTD
...
Also add a small comment explaining why this has been done.
2018-08-22 16:33:16 +05:30
Pradyun Gedam
d2e7377c0f
Reorganize pip's docs folder
2018-08-22 13:54:47 +05:30
Pradyun Gedam
2b3609a37d
Merge pull request #5664 from cjerdonek/issue-5375-svn-ssh-auth
...
Fix #5375 : add editable install support for svn+ssh URLs with a username
2018-08-22 08:33:08 +05:30
Pradyun Gedam
cc47adee9a
Change the import names as renamed
2018-08-05 14:24:18 +05:30
Pradyun Gedam
8650edd017
Merge pull request #5561 from pradyunsg/python-3.7
...
Document support for Py3.7 and enable testing of Py3.8-dev
2018-07-30 08:27:48 +05:30
Chris Jerdonek
e1d60f850b
Fix #5375 : add editable install support for svn+ssh URLs with a username.
2018-07-29 01:08:15 -07:00
Pradyun Gedam
3e81d8cde1
Merge pull request #5653 from pradyunsg/docs/update-release-process
...
Improve content in "Creating New Release" section
2018-07-28 23:22:47 +05:30
Pradyun Gedam
b3473b329d
Merge branch 'master' into python-3.7
2018-07-24 23:08:09 +05:30
Pradyun Gedam
43359d75b6
Address review comments from @pfmoore
2018-07-24 23:06:25 +05:30
Pradyun Gedam
13ca6bffc4
Improve text in create new release section
...
- Break up points that involve checking out git refs
- Include supporting comment for bumping version
- Drop outdated reference to "CHANGES.txt"
- Provide a link to get-pip repository
- Drop the outdated get-pip.py generation command
- Put all commmands that can be executed in parenthesis
2018-07-24 18:02:05 +05:30
Pradyun Gedam
bcc8fa8069
Remove redundant files from docs/ directory
2018-07-24 13:03:19 +05:30
Pradyun Gedam
4e8c247154
Document platforms/tooling new pip maintainers can be given access to
2018-07-24 10:54:51 +05:30
Pradyun Gedam
ef6c2f7229
Merge pull request #5635 from jcfr/fix-userguide-reference
...
user_guide: Fix "Requirements Files" reference
2018-07-24 08:45:04 +05:30
Pradyun Gedam
0734255da3
Don't mention pip in the headers of development docs pages
2018-07-24 01:18:12 +05:30
Pradyun Gedam
468e38fcf9
Add a note saying older references might be broken
2018-07-24 00:58:20 +05:30
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
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
Paul Moore
264aa69da1
Merge pull request #1675 from pfmoore/docs_setup_py
...
Document the build system interface used by pip
2014-04-04 17:22:46 +01:00
Donald Stufft
5a76a47d3b
Fix code to handle the latest flake8
2014-03-26 18:24:19 -04:00
Jannis Leidel
addfd202df
Update IRC channel name.
2014-03-26 22:39:27 +01:00
Marcus Smith
6ab9b30587
pip upgrades on windows
2014-03-26 11:08:00 -07:00
Marcus Smith
86aa5f1daa
pip upgrades on windows
2014-03-26 11:05:23 -07:00
Paul Moore
e0cf2b650e
Document the build system interface used by pip
2014-03-25 21:56:46 +00:00
Jannis Leidel
4d591cc81c
Update IRC channel name.
2014-03-23 14:36:58 +01:00
Marcus Smith
d4b691b743
remove mention of the unreleased virtualenv config support
2014-03-19 22:49:48 -07:00
Matthew Iversen
6181816d8a
Use Sphinx extlinks for github issues/pulls
...
- :issue:`DDD` results in #DDD
- :pull:`DDD` results in PR #DDD
- Updated CHANGES.txt to use these
- Refs PR #1647
2014-03-16 16:31:20 +11:00
Marcus Smith
4068c832c9
fill in missing word in the user guide
2014-03-15 10:04:48 -07:00
Marcus Smith
1f64f882e1
clarify non-recursive upgrades
2014-03-12 22:40:44 -07:00
Marcus Smith
af1d6d52a3
have pip just be an installer for simplicity. remove the vague "manage" description.
2014-03-11 09:08:52 -07:00
Matthew Iversen
d0e6c2fc54
Update docs to ref sorting order of list/freeze
2014-03-09 05:03:28 +11:00
anatoly techtonik
702e1e19ce
docs: Remove references to django-compressor
2014-03-08 12:48:05 +03:00
anatoly techtonik
f5f7a292c2
docs: Update makefiles to current Sphinx version
2014-03-08 12:45:02 +03:00
Daniele Procida
68cacfb71d
fixes #1615
2014-03-05 18:17:43 -05:00
Daniele Procida
459f026e20
fixes #1589
2014-03-03 23:06:44 +00:00
Tomer Chachamu
91b2674dad
Docs -- fix typo
2014-02-27 17:38:04 +00:00
Donald Stufft
95ac4c16f5
Remove dependency links support from pip
2014-02-25 18:39:40 -05:00
Donald Stufft
751eec65f3
Merge branch 'master' into develop
...
Conflicts:
CHANGES.txt
docs/configuration.rst
docs/cookbook.rst
docs/reference/pip.rst
docs/usage.rst
pip/__init__.py
pip/commands/install.py
pip/commands/wheel.py
pip/req.py
pip/wheel.py
tests/unit/test_wheel.py
2014-02-20 20:33:59 -05:00
coagulant
4879bc5e79
Documentation for --exists-action option
...
Fixes #1458
2014-02-15 02:12:39 +04:00
Marcus Smith
19ef5973cd
dropped support for Python 3.1
2014-02-11 22:33:24 -08:00
Marcus Smith
9e39d9d8ca
pip docs refactor
2014-02-11 22:13:03 -08:00
Marcus Smith
96bfe8b0f9
pip docs refactor
2014-02-11 21:55:43 -08:00
Marcus Smith
ffcd44c716
remove pip wheel
warnings due to merge of #1524
2014-02-04 22:15:43 -08:00
Donald Stufft
9f027337a8
Use Flake8 on the test of pip's Python files
2014-01-28 19:47:58 -05:00
Marcus Smith
4238127440
pip wheel
warning when wheels are already available on pypi
2014-01-25 11:33:35 -08:00
Marcus Smith
6d25e12dc8
pip wheel
warning when wheels are already available on pypi
2014-01-25 11:32:22 -08:00
Marcus Smith
b0b7a39696
docs fixes since the merge
2014-01-20 20:59:27 -08:00
Donald Stufft
e9a896a9a0
Merge branch 'master' into develop
...
Conflicts:
docs/installing.rst
pip/__init__.py
2014-01-20 22:48:44 -05:00
Donald Stufft
33e21377a5
Merge branch '1.5.X'
...
Conflicts:
docs/installing.rst
2014-01-20 22:47:14 -05:00
Marcus Smith
9d7d0005be
simpler install instructions due to get-pip.py installing setuptools
2014-01-14 20:59:20 -08:00
Marcus Smith
d680fd4f1f
merge from 1.5.X
2014-01-11 16:28:00 -08:00
Marcus Smith
7822931f59
replace the ez_setup instructions with simple pip commands
2014-01-10 22:42:35 -08:00
Marcus Smith
a7e8b9775a
Merge pull request #1450 from qwcode/pip_first_install
...
`get-pip`-first instructions, due to vendoring pkg_resources
2014-01-10 21:00:52 -08:00
Donald Stufft
dc8852bff2
The future is pip 1.5
2014-01-10 05:07:43 -05:00
Marcus Smith
71addee2be
get-pip
-first instructions, due to vendoring pkg_resources
2014-01-09 20:13:30 -08:00
Marcus Smith
4047b4b1bd
updates docs related to using PEP438 options in requirements files
2014-01-08 15:54:44 -08:00
Donald Stufft
6bd791df1d
Merge branch 'master' into develop
...
Conflicts:
pip/__init__.py
pip/_vendor/distlib/__init__.py
pip/_vendor/distlib/t32.exe
pip/_vendor/distlib/t64.exe
pip/_vendor/distlib/w32.exe
pip/_vendor/distlib/w64.exe
pip/_vendor/vendor.txt
tox.ini
2014-01-02 09:08:06 -05:00
Donald Stufft
0e84bd11fd
Merge branch '1.5.x'
...
Conflicts:
docs/conf.py
docs/installing.rst
2014-01-02 09:03:54 -05:00
Donald Stufft
c2361e72da
Remove note about next release
2014-01-02 08:16:41 -05:00
Donald Stufft
78992dc72f
Bump year
2014-01-02 08:16:28 -05:00
Daniel Jost
68288588a3
Minor grammar fix
2013-12-26 16:32:45 -08:00
Daniel Jost
6d353321e9
Minor grammar fix
2013-12-24 17:11:27 -06:00
Marcus Smith
f53befcd99
merge from 1.5.X
2013-12-08 15:24:42 -08:00
Paul Moore
1e7ae116f5
Typo fixes and clarifications
2013-12-08 12:08:22 +00:00
Paul Moore
884861f390
Added a virtualenv-specific configuration file
2013-12-04 13:04:54 +00:00
Marcus Smith
b5eb6122cd
fix typo in find-links usage examples
2013-11-30 23:34:47 -08:00
Marcus Smith
5e0eeb2af6
rules and examples for how pip install --user
works
2013-11-30 23:05:00 -08:00
Donald Stufft
2ad8ce4fae
Merge pull request #1260 from techtonik/develop
...
Add pull request process example
2013-11-22 05:57:59 -08:00
Marcus Smith
eaa565fdaa
unsuppress --log-file
2013-11-14 18:13:23 -08:00
Marcus Smith
9f94221ff6
better detection of docs theme
2013-11-13 15:59:06 -08:00
Marcus Smith
df270943ae
use default theme, so we can evolve with RTD's design efforts.
2013-11-10 13:36:22 -08:00
Marcus Smith
0812926412
Merge pull request #1312 from pypa/docs_rtd
...
use default theme, so we can evolve with RTD's design efforts.
2013-11-10 11:32:09 -08:00
Marcus Smith
276a13a556
use default theme, so we can evolve with RTD's design efforts.
2013-11-10 11:17:34 -08:00
Donald Stufft
b809fd6feb
Fix the flag name
2013-11-07 15:52:46 -05:00
Donald Stufft
bc224cd81a
Remove --use-wheel from the docs
2013-11-07 15:50:04 -05:00
Marcus Smith
04f78cc71f
allow pip to install Mac wheels from pypi (in addition to Windows wheels)
2013-10-31 20:54:25 -07:00
Marcus Smith
c397e19deb
Added a section for "pip" itself in the usage.
...
The top of the usage page needed something to hold the
orphaned General and Index options, otherwise it's disorientating.
2013-10-29 14:18:02 -07:00
anatoly techtonik
56a62dc8d2
docs: Expand development section example for #1259
2013-10-27 19:52:56 +03:00
anatoly techtonik
78c299aee7
Expand development instructions, fixes #1259
2013-10-27 19:30:14 +03:00
Donald Stufft
fac6021466
Fix up the documentation
2013-10-26 23:54:41 -04:00
Marcus Smith
0cd0aba40d
Merge pull request #1247 from qwcode/req_docs
...
improved cookbook entry for "Requirements Files"
2013-10-23 15:59:05 -07:00
Marcus Smith
6c1e87a16b
details on logging for users, but also for maintainers
2013-10-23 00:36:10 -07:00
Marcus Smith
0e7f1ab0be
improved cookbook entry for "Requirements Files"
2013-10-22 19:30:43 -07:00
Paul Nasrat
951ef7438c
Merge remote-tracking branch 'niedbalski/develop' into subdirectory-editable
...
Conflicts:
CHANGES.txt
tests/functional/test_install_reqs.py
tests/lib/__init__.py
tests/unit/test_req.py
Additional work - refactored tests to new style.
2013-09-27 14:42:05 -04:00
Hynek Schlawack
b90fc1ad8d
Mention wheel as an egg replacement
...
While it’s true that pip can’t install eggs, it’s not true anymore that it installs only source distributions.
2013-09-19 17:12:57 +02:00
Marcus Smith
15910f573e
define options once, but don't globally instantiate
2013-09-16 22:21:15 -07:00
Marcus Smith
9075942002
mention pypi hash instability and the peep project
2013-09-09 18:41:32 -07:00
Baptiste Mispelon
e337e47db8
Add a link to the configuration file section from the cookbook.
2013-09-07 19:17:07 +02:00
Marcus Smith
54ed8ba0df
self-contained, non-circular install instructions
2013-08-29 20:57:54 -07:00
Marcus Smith
9242dbfe8a
self-contained, non-circular install instructions
2013-08-28 20:43:20 -07:00
Donald Stufft
eae5ffc11a
Test that the documentation builds successfully
2013-08-28 06:49:28 -04:00
Donald Stufft
ed31b98c59
Document the usage of tox to run the tests
2013-08-28 06:10:49 -04:00
Donald Stufft
da0bc4b1d1
Switch to using py.test as the test runner instead of nose
...
* Better output with the bare asserts we use throughout the tests
* Function fixtures are pretty nice, especially as a way to
start a background server or create an isolated virtualenv
2013-08-21 10:19:58 -04:00
Jorge Niedbalski
89c1eb5f01
[docs/usage.rst] added example of subdirectory installation
2013-08-20 10:38:31 -03:00
David Pursehouse
77665b9254
Minor grammatical fixes in the cookbook
2013-08-09 15:24:05 +09:00
Donald Stufft
fcdee3c652
Merge branch 'master' into develop
...
Conflicts:
.travis.yml
CHANGES.txt
pip/__init__.py
tests/functional/test_install_index.py
2013-08-07 21:21:32 -04:00
Marcus Smith
1e9202a861
add cookbook entry for distribute to setuptools upgrade
2013-08-07 16:36:02 -07:00
David Pursehouse
a53e2bee20
Fix upgrade examples in cookbook
2013-08-05 10:28:45 +09:00
Jannis Leidel
5dd05a9718
More doc updates.
2013-07-23 21:47:52 +02:00
Jannis Leidel
e3bf9c40ec
Remove the changelog from the PyPI page and add links to it and the installation docs.
...
Also some minor stylistic changes.
2013-07-23 19:53:54 +02:00
Marcus Smith
0e342bc129
update changelog with note about case where distribute upgrade can fail
2013-07-06 00:03:47 -07:00
Marcus Smith
31c29c6d2f
new install instructions after release of setuptools-0.8/distribute-0.7.3
2013-07-05 22:45:29 -07:00
Marcus Smith
f7fa8359a5
setuptools upgrade instructions
2013-07-03 13:53:26 -07:00
Marcus Smith
3a7f416df9
wheel cookbook updates
2013-07-02 23:01:47 -07:00
Marcus Smith
aed3b3bea1
updated install/upgrade instructions
2013-07-02 21:15:52 -07:00
Marcus Smith
be1f752e8b
note that setuptools-0.8 final is not released to pypi yet
2013-06-28 14:52:14 -07:00
Marcus Smith
fb397cd1ec
have "pip wheel" only be satisfied by setuptools
2013-06-27 00:20:28 -07:00