]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
Doc updates for py25 removal
authorBen Darnell <ben@bendarnell.com>
Sat, 19 Jan 2013 17:58:54 +0000 (12:58 -0500)
committerBen Darnell <ben@bendarnell.com>
Sat, 19 Jan 2013 17:58:54 +0000 (12:58 -0500)
README.md
website/sphinx/releases/next.rst
website/templates/index.html

index 1fc8c24454563d61680065d42af4dc8b1adb4bdd..2cdb05a7d85c2d5bc7285f4d0863d73c2856e7bd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,10 +18,10 @@ way, so you may wish to download a copy of the source tarball as well.
 Manual installation
 -------------------
 
-Download https://github.com/downloads/facebook/tornado/tornado-2.3.tar.gz
+Download the latest release from http://pypi.python.org/pypi/tornado
 
-    tar xvzf tornado-2.3.tar.gz
-    cd tornado-2.3
+    tar xvzf tornado-$VERSION.tar.gz
+    cd tornado-$VERSION
     python setup.py build
     sudo python setup.py install
 
@@ -34,22 +34,23 @@ the standard library includes epoll support.
 Prerequisites
 -------------
 
-Tornado runs on Python 2.5, 2.6, 2.7 and 3.2.
+Tornado runs on Python 2.6+ and 3.2+.  Both CPython and PyPy are supported.
 
-On Python 2.6 and 2.7, there are no dependencies outside the Python
-standard library, although PycURL (version 7.18.2 or higher required;
-version 7.21.1 or higher recommended) may be used if desired.
+There are no required dependencies outside the Python standard library,
+although unittest2 is required to run Tornado's unittest suite on
+Python 2.6.
 
-On Python 2.5, PycURL is required, along with simplejson and the
-Python development headers (typically obtained by installing a package
-named something like python-dev from your operating system).
+Certain optional features require additional third-party modules:
 
-On Python 3.2, the distribute package is required. Note that Python 3
-support is relatively new and may have bugs.
+* tornado.curl_httpclient needs PycURL (version 7.18.2 or higher required;
+  version 7.21.1 or higher recommended)
+* Multithreading support requires the concurrent.futures module,
+  which is in the standard library for Python 3.2+ and available
+  at http://pypi.python.org/pypi/futures for older versions.
 
 Platforms
 ---------
 
- Tornado should run on any Unix-like platform, although for the best
+Tornado should run on any Unix-like platform, although for the best
 performance and scalability only Linux and BSD (including BSD
 derivatives like Mac OS X) are recommended.
index 465572ded7d0c9887cbf5b5dc597883ef403c039..28e6a2199b0400b0fa0782e3a9075a7fbfeec3df 100644 (file)
@@ -4,8 +4,7 @@ What's new in the next release of Tornado
 In progress
 -----------
 
-* The Tornado test suite now requires ``unittest2`` when run on Python 2.5
-  or 2.6.
+* The Tornado test suite now requires ``unittest2`` when run on Python 2.6.
 * `tornado.testing.AsyncTestCase` and friends now extend ``unittest2.TestCase``
   when it is available (and continue to use the standard ``unittest`` module
   when ``unittest2`` is not available)
@@ -208,3 +207,5 @@ In progress
 * `IOStream.close` now has an ``exc_info`` argument (similar to the
   one used in the `logging` module) that can be used to set the stream's
   ``error`` attribute when closing it.
+* Python 2.5 is no longer supported.
+* Installation under Python 3 no longer uses ``2to3``.
index 9414d2f2b4ccbfffc7f106f39f3b7a312992f970..bd61129a0367727d422c4a9e4710418878684f01 100644 (file)
@@ -49,13 +49,12 @@ if __name__ == "__main__":
 cd tornado-{{version}}
 python setup.py build
 sudo python setup.py install</code></pre>
-  <p>The Tornado source code is <a href="https://github.com/facebook/tornado">hosted on GitHub</a>.  On Python 2.6 and 2.7, it is also possible to simply add the tornado directory to your <code>PYTHONPATH</code> instead of building with <code>setup.py</code>, since the standard library includes <code>epoll</code> support.</p>
+  <p>The Tornado source code is <a href="https://github.com/facebook/tornado">hosted on GitHub</a>.  It is also possible to simply add the tornado directory to your <code>PYTHONPATH</code> instead of building with <code>setup.py</code>.
 
-  <p><b>Prerequisites:</b> Tornado runs on Python 2.5, 2.6, 2.7 and 3.2.
+  <p><b>Prerequisites:</b> Tornado runs on Python 2.6+ and 3.2+.  Both CPython and PyPy are supported.  There are no required dependencies outside the Python standard library, although unittest2 is required to run Tornado's unittest suite on Python 2.6.  Certain optional features require additional third-party modules:
   <ul>
-    <li>On Python 2.6 and 2.7, there are no dependencies outside the Python standard library, although <a href="http://pycurl.sourceforge.net/">PycURL</a> (version 7.18.2 or higher required; version 7.21.1 or higher recommended) may be used if desired.</li>
-    <li>On Python 2.5, PycURL is required, along with <a href="http://pypi.python.org/pypi/simplejson/">simplejson</a> and the Python development headers (typically obtained by installing a package named something like <code>python-dev</code> from your operating system).</li>
-    <li>On Python 3.2, the <a href="http://pypi.python.org/pypi/distribute">distribute</a> package is required.  Note that Python 3 support is relatively new and may have bugs.</li>
+    <li>tornado.curl_httpclient needs <a href="http://pycurl.sourceforge.net/">PycURL</a> (version 7.18.2 or higher required; version 7.21.1 or higher recommended)</li>
+    <li>Multithreading support requires the concurrent.futures module, which is in the standard library for Python 3.2+ and available <a href="http://pypi.python.org/pypi/futures">on pypi</a> for older versions.</li>
   </ul></p>
 
   <p><b>Platforms:</b> Tornado should run on any Unix-like platform, although