mirror of
https://github.com/pypa/pip
synced 2023-12-13 21:30:23 +01:00
docs and cli error text updates
This commit is contained in:
parent
0353788661
commit
103db0d62d
|
@ -2,19 +2,27 @@
|
||||||
Development
|
Development
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. include:: ../PROJECT.txt
|
|
||||||
|
|
||||||
|
|
||||||
Pull Requests
|
Pull Requests
|
||||||
=============
|
=============
|
||||||
|
|
||||||
* Submit Pull Requests against the `develop` branch.
|
Submit Pull Requests against the `develop` branch.
|
||||||
* Provide a good description of what your doing and why.
|
|
||||||
* Provide tests that cover your changes.
|
|
||||||
* Please try to run the tests locally first.
|
|
||||||
* All pull requests are tested using Travis upon submission.
|
|
||||||
* The only way to trigger Travis to run again, is to submit a change to the pull branch.
|
|
||||||
|
|
||||||
|
Provide a good description of what your doing and why.
|
||||||
|
|
||||||
|
Provide tests that cover your changes and try to run the tests locally first.
|
||||||
|
|
||||||
|
Automated Testing
|
||||||
|
=================
|
||||||
|
|
||||||
|
All pull requests and merges to 'develop' branch are tested in `Travis <https://travis-ci.org/>`_
|
||||||
|
based on our `.travis.yml file <https://github.com/pypa/pip/blob/develop/.travis.yml>`_.
|
||||||
|
|
||||||
|
Usually, a link to your specific travis build appears in pull requests, but if not,
|
||||||
|
you can find it on our `travis pull requests page <https://travis-ci.org/pypa/pip/pull_requests>`_
|
||||||
|
|
||||||
|
The only way to trigger Travis to run again for a pull request, is to submit another change to the pull branch.
|
||||||
|
|
||||||
|
We also have Jenkins CI that runs regularly for certain python versions on windows and centos.
|
||||||
|
|
||||||
Running tests
|
Running tests
|
||||||
=============
|
=============
|
||||||
|
@ -42,6 +50,60 @@ The pip project welcomes help in the following ways:
|
||||||
- Helping to answer questions on the mailing list.
|
- Helping to answer questions on the mailing list.
|
||||||
|
|
||||||
If you want to become an official maintainer, start by helping out.
|
If you want to become an official maintainer, start by helping out.
|
||||||
|
|
||||||
Later, when you think you're ready, get in touch with one of the maintainers,
|
Later, when you think you're ready, get in touch with one of the maintainers,
|
||||||
and they will initiate a vote.
|
and they will initiate a vote.
|
||||||
|
|
||||||
|
Release Process
|
||||||
|
===============
|
||||||
|
|
||||||
|
This process includes virtualenv, since pip releases necessitate a virtualenv release.
|
||||||
|
|
||||||
|
:<oldp>/<newp>: refers to the old and new versions of pip.
|
||||||
|
:<oldv>/<newv>: refers to the old and new versions of virtualenv.
|
||||||
|
|
||||||
|
1. Upgrade distribute, if needed:
|
||||||
|
#. Upgrade distribute in ``virtualenv:develop`` using the :ref:`Refresh virtualenv` process.
|
||||||
|
#. Create a pull request against ``pip:develop`` with a modified ``.travis.yml`` file that installs virtualenv from ``virtualenv:develop``, to confirm the travis builds are still passing.
|
||||||
|
3. Create Release branches:
|
||||||
|
#. Create ``pip:<newp>`` branch.
|
||||||
|
#. In ``pip:develop``, change ``pip.version`` to '<newp>.post1'.
|
||||||
|
#. Create ``virtualenv:<newv>`` branch.
|
||||||
|
#. In ``virtualenv:develop``, change ``virtualenv.version`` to '<newv>.post1'.
|
||||||
|
4. Prepare "rcX":
|
||||||
|
#. In ``pip:<newp>``, change ``pip.version`` to '<newp>rcX', and tag with '<newp>rcX'.
|
||||||
|
#. Build a pip sdist from ``pip:<newp>``, and build it into ``virtualenv:<newv>`` using the :ref:`Refresh virtualenv` process.
|
||||||
|
#. In ``virtualenv:<newv>``, change ``virtualenv.version`` to '<newv>rcX', and tag with '<newv>rcX'.
|
||||||
|
5. Announce ``pip-<newp>rcX`` and ``virtualenv-<newv>rcX`` with the :ref:`RC Install Instructions` and elicit feedback.
|
||||||
|
6. Apply fixes to 'rcX':
|
||||||
|
#. Apply fixes to ``pip:<newp>`` and ``virtualenv:<newv>``
|
||||||
|
#. Periodically merge fixes to ``pip:develop`` and ``virtualenv:develop``
|
||||||
|
7. Repeat #4 thru #6 if needed.
|
||||||
|
8. Final Release:
|
||||||
|
#. In ``pip:<newp>``, change ``pip.version`` to '<newp>', and tag with '<newp>'.
|
||||||
|
#. Merge ``pip:<newp>`` to ``pip:master``.
|
||||||
|
#. Build a pip sdist from ``pip:<newp>``, and load it into ``virtualenv:<newv>`` using the :ref:`Refresh virtualenv` process.
|
||||||
|
#. Merge ``vitualenv:<newv>`` to ``virtualenv:develop``.
|
||||||
|
#. In ``virtualenv:<newv>``, change ``virtualenv.version`` to '<newv>', and tag with '<newv>'.
|
||||||
|
#. Merge ``virtualenv:<newp>`` to ``virtualenv:master``
|
||||||
|
|
||||||
|
.. _`Refresh virtualenv`:
|
||||||
|
|
||||||
|
Refresh virtualenv
|
||||||
|
++++++++++++++++++
|
||||||
|
|
||||||
|
#. Set the embedded versions of pip, distribute and setuptools in ``bin/refresh-support-files.py``
|
||||||
|
#. Additionally, set the version of distribute in ``virtualenv_embedded/distribute_setup.py``, and setuptools in ``virtualenv_embedded/ez_setup.py``
|
||||||
|
#. Run ``bin/refresh-support-files.py`` to download the latest versions.
|
||||||
|
When specifying a beta of pip not on pypi, the last part of this script will fail. In this case, the pip sdist needs to be placed manually into ``virtualenv_support``.
|
||||||
|
#. Run ``bin/rebuild-script.py`` to rebuild virtualenv based on the latest versions.
|
||||||
|
|
||||||
|
|
||||||
|
.. _`RC Install Instructions`:
|
||||||
|
|
||||||
|
RC Install Instructions
|
||||||
|
+++++++++++++++++++++++
|
||||||
|
|
||||||
|
#. Download and unpack ``https://github.com/pypa/virtualenv/archive/<newv>rcX.tar.gz``
|
||||||
|
#. Run: ``python virtualenv-<newv>rcX/virtualenv.py myVE``
|
||||||
|
#. ``myVE/bin/pip`` will be the <newp>rcX version of pip.
|
||||||
|
|
|
@ -3,6 +3,13 @@ pip
|
||||||
|
|
||||||
A tool for installing and managing Python packages.
|
A tool for installing and managing Python packages.
|
||||||
|
|
||||||
|
`Mailing list <http://groups.google.com/group/python-virtualenv>`_ ``|``
|
||||||
|
`Issues <https://github.com/pypa/pip/issues>`_ ``|``
|
||||||
|
`Github <https://github.com/pypa/pip>`_ ``|``
|
||||||
|
`PyPI <http://pypi.python.org/pypi/pip/>`_ ``|``
|
||||||
|
irc:#pip
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
|
|
@ -1393,7 +1393,7 @@ def parse_editable(editable_req, default_vcs=None):
|
||||||
url = default_vcs + '+' + url
|
url = default_vcs + '+' + url
|
||||||
else:
|
else:
|
||||||
raise InstallationError(
|
raise InstallationError(
|
||||||
'--editable=%s should be formatted with svn+URL, git+URL, hg+URL or bzr+URL' % editable_req)
|
'%s should either by a path to a local project or a VCS url beginning with svn+, git+, hg+, or bzr+' % editable_req)
|
||||||
vc_type = url.split('+', 1)[0].lower()
|
vc_type = url.split('+', 1)[0].lower()
|
||||||
if not vcs.get_backend(vc_type):
|
if not vcs.get_backend(vc_type):
|
||||||
error_message = 'For --editable=%s only ' % editable_req + \
|
error_message = 'For --editable=%s only ' % editable_req + \
|
||||||
|
|
|
@ -119,7 +119,7 @@ class VersionControl(object):
|
||||||
"""
|
"""
|
||||||
error_message= (
|
error_message= (
|
||||||
"Sorry, '%s' is a malformed VCS url. "
|
"Sorry, '%s' is a malformed VCS url. "
|
||||||
"Ihe format is <vcs>+<protocol>://<url>, "
|
"The format is <vcs>+<protocol>://<url>, "
|
||||||
"e.g. svn+http://myrepo/svn/MyApp#egg=MyApp")
|
"e.g. svn+http://myrepo/svn/MyApp#egg=MyApp")
|
||||||
assert '+' in self.url, error_message % self.url
|
assert '+' in self.url, error_message % self.url
|
||||||
url = self.url.split('+', 1)[1]
|
url = self.url.split('+', 1)[1]
|
||||||
|
|
Loading…
Reference in a new issue