summaryrefslogtreecommitdiff
path: root/doc/install.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2014-09-27 11:08:12 -0400
committerNed Batchelder <ned@nedbatchelder.com>2014-09-27 11:08:12 -0400
commit2a2b3f3a7272cc3b75b5fd8af86ac1d31b9f6411 (patch)
treee02f520257e255c633e27053d06ef82e9144f0be /doc/install.rst
parentf19c747b1c3b1d74002b44acf4cd2d4ccca67a44 (diff)
downloadpython-coveragepy-git-2a2b3f3a7272cc3b75b5fd8af86ac1d31b9f6411.tar.gz
Update version and docs for 4.0a1
Diffstat (limited to 'doc/install.rst')
-rw-r--r--doc/install.rst29
1 files changed, 18 insertions, 11 deletions
diff --git a/doc/install.rst b/doc/install.rst
index bc8097a2..7dfa5668 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -20,29 +20,36 @@ Installation
:history: 20130105T174400, updated for 3.6.
:history: 20131005T210600, updated for 3.7.
:history: 20131212T213500, updated for 3.7.1.
+:history: 20140927T102700, updated for 4.0a1.
.. highlight:: console
+
.. _coverage_pypi: http://pypi.python.org/pypi/coverage
.. _setuptools: http://pypi.python.org/pypi/setuptools
.. _Distribute: http://packages.python.org/distribute/
-Installing coverage.py is done in the usual ways. You must have `setuptools`_
-or `Distribute`_ installed already, and then you:
+Installing coverage.py is done in the usual ways. The simplest way is with
+pip::
-#. Download the appropriate kit from the
- `coverage page on the Python Package Index`__.
+ $ pip install coverage
-#. Run ``python setup.py install``.
+.. ifconfig:: prerelease
-or, use::
+ To install a pre-release version, you will need to specify ``--pre``::
- $ pip install coverage
+ $ pip install --pre coverage
-or even::
- $ easy_install coverage
+The alternate old-school technique is:
+
+#. Install (or already have installed) `setuptools`_ or `Distribute`_.
+
+#. Download the appropriate kit from the
+ `coverage page on the Python Package Index`__.
+
+#. Run ``python setup.py install``.
.. __: coverage_pypi_
@@ -75,9 +82,9 @@ If all went well, you should be able to open a command prompt, and see coverage
installed properly::
$ coverage --version
- Coverage.py, version 3.7.1. http://nedbatchelder.com/code/coverage
+ Coverage.py, version 4.0a1. http://nedbatchelder.com/code/coverage
You can also invoke coverage as a module::
$ python -m coverage --version
- Coverage.py, version 3.7.1. http://nedbatchelder.com/code/coverage
+ Coverage.py, version 4.0a1. http://nedbatchelder.com/code/coverage