]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- add notes for prerelease install
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 13 Mar 2015 20:33:44 +0000 (16:33 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 13 Mar 2015 20:36:43 +0000 (16:36 -0400)
doc/build/intro.rst

index 5ac28a7c44bc3aba5f5932fe3eaf6c6eea55ee68..ea4a3ce11fa49cd294b02bc02e4dd62e89823275 100644 (file)
@@ -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 <http://pypi.python.org/pypi/SQLAlchemy>`_ 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
 ----------------------------------