[py-svn] py-trunk commit a2fdaf73b6be: simplify and fix installation instructions particularly for windows (fixes #111)

[mailer at bitbucket.org]

# HG changeset patch -- Bitbucket.org
# Project py-trunk
# URL http://bitbucket.org/hpk42/py-trunk/overview
# User holger krekel <holger at merlinux.eu>
# Date 1284471780 -7200
# Node ID a2fdaf73b6be96cad2c05fe6545d4dbe6ec6b73b
# Parent  9684ef61e64e3e4828bf043448a0cd0363fab321
simplify and fix installation instructions particularly for windows (fixes #111)
and bump version to 1.3.4

--- a/py/__init__.py
+++ b/py/__init__.py
@@ -8,7 +8,7 @@ dictionary or an import path.
 
 (c) Holger Krekel and others, 2004-2010
 """
-__version__ = version = "1.3.4a1"
+__version__ = version = "1.3.4"
 
 import py.apipkg
 

--- a/setup.py
+++ b/setup.py
@@ -26,14 +26,14 @@ def main():
         name='py',
         description='py.test and pylib: rapid testing and development utils.',
         long_description = long_description,
-        version= '1.3.4a1',
+        version= '1.3.4',
         url='http://pylib.org',
         license='MIT license',
         platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'],
         author='holger krekel, Guido Wesdorp, Carl Friedrich Bolz, Armin Rigo, Maciej Fijalkowski & others',
         author_email='holger at merlinux.eu',
         entry_points= make_entry_points(),
-        classifiers=['Development Status :: 5 - Production/Stable',
+        classifiers=['Development Status :: 6 - Mature',
                      'Intended Audience :: Developers',
                      'License :: OSI Approved :: MIT License',
                      'Operating System :: POSIX',

--- a/doc/install.txt
+++ b/doc/install.txt
@@ -26,7 +26,47 @@ py.test/pylib installation info in a nut
 .. _`bin`: bin.html
 
 
-Best practise: install tool and dependencies virtually
+.. _`easy_install`:
+
+Installation using easy_install
+===================================================
+
+Both `Distribute`_ and setuptools_ provide the ``easy_install``
+installation tool with which you can type into a command line window::
+
+    easy_install -U py
+
+to install the latest release of the py lib and py.test.  The ``-U`` switch
+will trigger an upgrade if you already have an older version installed.
+Note that setuptools works ok with Python2 interpreters while `Distribute`_
+additionally works with Python3 and also avoid some issues on Windows.
+
+Known issues:
+
+- **Windows**: If "easy_install" or "py.test" are not found
+  please see here for preparing your environment for running
+  command line tools: `Python for Windows`_.  You may alternatively
+  use an `ActivePython install`_ which makes command line tools
+  automatically available under Windows.
+
+.. _`ActivePython install`: http://www.activestate.com/activepython/downloads
+
+.. _`Jython does not create command line launchers`: http://bugs.jython.org/issue1491
+
+- **Jython2.5.1 on Windows XP**: `Jython does not create command line launchers`_
+  so ``py.test`` will not work correctly.  You may install py.test on
+  CPython and type ``py.test --genscript=mytest`` and then use
+  ``jython mytest`` to run py.test for your tests to run in Jython.
+
+- **On Linux**: If ``easy_install`` fails because it needs to run
+  as the superuser you are trying to install things globally
+  and need to put ``sudo`` in front of the command.
+
+
+.. _quickstart: test/quickstart.html
+
+
+Recommendation: install tool and dependencies virtually
 ===========================================================
 
 It is recommended to work with virtual environments
@@ -36,34 +76,9 @@ you need to run your tests.  Local virtu
 (as opposed to system-wide "global" environments) make for a more
 reproducible and reliable test environment.
 
-
 .. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
 .. _`buildout`: http://www.buildout.org/
 .. _pip: http://pypi.python.org/pypi/pip
-.. _`easy_install`:
-
-using easy_install (from setuptools or Distribute)
-===================================================
-
-Both `Distribute`_ and setuptools_ provide the ``easy_install``
-installation tool.  While setuptools should work ok with
-Python2 interpreters, `Distribute`_ also works with Python3
-and it avoids some issues on Windows.  In both cases you
-can open a command line window and then type::
-
-    easy_install -U py
-
-to install the latest release of the py lib and py.test.  The ``-U`` switch
-will trigger an upgrade if you already have an older version installed.
-
-If you now type::
-
-    py.test --version
-
-you should see the version number and the import location of the tool.
-Maybe you want to head on with the `quickstart`_ now?
-
-.. _quickstart: test/quickstart.html
 
 .. _standalone:
 
@@ -84,24 +99,7 @@ disguise.  You can tell people to downlo
 and ask them to send you the resulting URL.  The resulting script has
 all core features and runs unchanged under Python2 and Python3 interpreters.
 
-Troubleshooting / known issues
-===============================
-
-.. _`Jython does not create command line launchers`: http://bugs.jython.org/issue1491
-
-**Jython2.5.1 on XP**: `Jython does not create command line launchers`_
-so ``py.test`` will not work correctly.  You may install py.test on
-CPython and type ``py.test --genscript=mytest`` and then use
-``jython mytest`` to run py.test for your tests to run in Jython.
-
-**On Linux**: If ``easy_install`` fails because it needs to run
-as the superuser you are trying to install things globally
-and need to put ``sudo`` in front of the command.
-
-**On Windows**: If "easy_install" or "py.test" are not found
-please see here: `How do i run a Python program under Windows?`_
-
-.. _`How do i run a Python program under Windows?`: http://www.python.org/doc/faq/windows/#how-do-i-run-a-python-program-under-windows
+.. _`Python for Windows`: http://www.imladris.com/Scripts/PythonForWindows.html
 
 .. _mercurial: http://mercurial.selenic.com/wiki/
 .. _`Distribute`:

--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,6 +1,7 @@
-Changes between 1.3.3 and XXX
+Changes between 1.3.3 and 1.3.4
 ==================================================
 
+- fix issue111: improve install documentation for windows
 - fix issue116: --doctestmodules works in the presence of __init__.py files as well
 - fix issue118: new --tb=native option for presenting cpython-standard exceptions