Install
===============

.. contents:: In this section:
   :depth: 1
   :local:

.. _label-install-reqs:

System Requirements
--------------------

Requires any Python 2.4.4 to 2.7.x. The following table identifies on which 
combination of Python and Platform the unit tests have been run. The result 
for each combination is number of tests passed out of total number of tests, 
and "n/t" means "not tested":

    ============ =========== =========== =============
         \        Windows 7   Ubuntu 12   Other Linux 
    ============ =========== =========== =============
    Python 2.4.4    64/64(*)     n/t         n/t
    Python 2.5       n/t         n/t         n/t
    Python 2.6       n/t         n/t         n/t
    Python 2.7      64/64        n/t         n/t
    PyPy 2.1        56/64        n/t         n/t
    Python 3.3       0/64        0/64        0/64  
    ============ =========== =========== =============
    
    (*) *required two test harness files (nose/failure.py and nose/capture.py) to be patched 
    (one line each): change BaseException (introduced in Python 2.5) to Exception.*

Let us know (schoenborno [at] users.sourceforge.net) if you have successfully used pubsub with 
other combinations of Python and Platform.


How-to
--------------

Several methods are available: egg distribution, Windows installer, zip file with source, or 
directly from source code repository. 

Method 1. Using setuptools (easy_install)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This method should work on all platforms supported by Python. 

If you have setuptools installed on your machine, 
   
1. From a console window, do :command:`easy_install -Z pypubsub` 
2. If for whatever reason easy_install can't find the pypubsub download, you could try manually 
   downloading the `egg distribution
   <http://sourceforge.net/projects/pubsub/files/pubsub/>`_
   from SourceForge.net. Then do :command:`easy_install -Z <downloaded_egg>` 

Method 2. Using Installer (Windows only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Download the `Installer (PyPubSub-xxx.win32.exe)
   <http://sourceforge.net/projects/pubsub/files/pubsub/>`_
   from SourceForge.net.
2. Run the installer

Method 3. From source distribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Download the appropriate `ZIP file
   <http://sourceforge.net/projects/pubsub/files/pubsub/>`_
   from SourceForge.net.
2. Extract the contents
3. From a console window, cd to extracted folder
4. Then do :command:`python setup.py install` 

Method 4. From source code repository
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Using a subversion client, do an SVN checkout of 
   **svn://svn.code.sf.net/p/pubsub/code/trunk**
2. From a console window, cd to pubsub-code
3. In console, do :command:`python setup.py install` 

.. image:: http://sflogo.sourceforge.net/sflogo.php?group_id=197063&amp;type=2
   :alt: SourceForge.net Logo
   :width: 125
   :height: 37
   :target: http://sourceforge.net


.. _label-support:

Support
--------

The forums are currently hosted on google groups:

- http://googlegroups.com/group/pypubsub: PyPubSub general help and support (hosted by Google Groups)

- http://googlegroups.com/group/pypubsub_dev: PyPubSub bug reports, feature suggestions, patches, etc (hosted by Google Groups)

Also, many pypubsub users are on the `wxPython-users mailing list  <http://www.wxpython.org/maillist.php>`_.


Release Notes
---------------

.. include:: ../RELEASE_NOTES.txt


.. include:: changelog.rst