From: Mike Bayer Date: Fri, 13 Mar 2015 20:33:44 +0000 (-0400) Subject: - add notes for prerelease install X-Git-Tag: rel_1_0_0b1~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f1e777b2abcef0ad56d3c1f58ee33492abe37998;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git - add notes for prerelease install --- diff --git a/doc/build/intro.rst b/doc/build/intro.rst index 5ac28a7c44..ea4a3ce11f 100644 --- a/doc/build/intro.rst +++ b/doc/build/intro.rst @@ -93,25 +93,25 @@ SQLAlchemy supports installation using standard Python "distutils" or rides on top of ``setuptools`` or ``distribute``, replacing the usage of ``easy_install``. It is often preferred for its simpler mode of usage. -Install via easy_install or pip -------------------------------- +Install via pip +--------------- -When ``easy_install`` or ``pip`` is available, the distribution can be +When ``pip`` is available, the distribution can be downloaded from Pypi and installed in one step:: - easy_install SQLAlchemy - -Or with pip:: - pip install SQLAlchemy -This command will download the latest version of SQLAlchemy from the `Python +This command will download the latest **released** version of SQLAlchemy from the `Python Cheese Shop `_ and install it to your system. -.. note:: +In order to install the latest **prerelease** version, such as ``1.0.0b1``, +pip requires that the ``--pre`` flag be used:: + + pip install --pre SQLAlchemy + +Where above, if the most recent version is a prerelease, it will be installed +instead of the latest released version. - Beta releases of SQLAlchemy may not be present on Pypi, and may instead - require a direct download first. Installing using setup.py ----------------------------------