~barry/mailman/lp1423756

« back to all changes in this revision

Viewing changes to src/mailman/docs/START.rst

  • Committer: Barry Warsaw
  • Date: 2015-01-05 01:20:33 UTC
  • mfrom: (7264.4.66 py3)
  • Revision ID: barry@list.org-20150105012033-zdrw9c2odhpf22fz
Merge the Python 3 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
39
39
Requirements
40
40
============
41
41
 
42
 
Python 2.7 is required.  It can either be the default 'python' on your
43
 
``$PATH`` or it can be accessible via the ``python2.7`` binary.  If
44
 
your operating system does not include Python, see http://www.python.org
45
 
for information about downloading installers (where available) and
46
 
installing it from source (when necessary or preferred).  Python 3 is
47
 
not yet supported.
 
42
Python 3.4 or newer is required.  It can either be the default 'python3' on
 
43
your ``$PATH`` or it can be accessible via the ``python3.4`` binary.  If your
 
44
operating system does not include Python, see http://www.python.org for
 
45
information about downloading installers (where available) and installing it
 
46
from source (when necessary or preferred).  Python 2 is not supported.
48
47
 
49
48
You may need some additional dependencies, which are either available from
50
49
your OS vendor, or can be downloaded automatically from the `Python
80
79
You do have access to the virtualenv, and you can use this to run individual
81
80
tests, e.g.::
82
81
 
83
 
    $ .tox/py27/bin/python -m nose2 -vv -P user
 
82
    $ .tox/py34/bin/python -m nose2 -vv -P user
84
83
 
85
 
Use `.tox/py27/bin/python -m nose2 --help` for more options.
 
84
Use `.tox/py34/bin/python -m nose2 --help` for more options.
86
85
 
87
86
If you want to run the full test suite against the PostgreSQL database, set
88
87
the database up as described in :doc:`DATABASE`, then create a `postgres.cfg`
112
111
 
113
112
First, create a virtual environment.  By default ``virtualenv`` uses the
114
113
``python`` executable it finds first on your ``$PATH``.  Make sure this is
115
 
Python 2.7 (just start the interactive interpreter and check the version in
 
114
Python 3.4 (just start the interactive interpreter and check the version in
116
115
the startup banner).  The directory you install the virtualenv into is up to
117
 
you, but for purposes of this document, we'll install it into ``/tmp/py27``::
118
 
 
119
 
    % virtualenv --system-site-packages /tmp/py27
120
 
 
121
 
If your default Python is not version 2.7, use the ``--python`` option to
 
116
you, but for purposes of this document, we'll install it into ``/tmp/mm3``::
 
117
 
 
118
    % virtualenv -p python3 --system-site-packages /tmp/mm3
 
119
 
 
120
If your default Python is not version 3.4, use the ``--python`` option to
122
121
specify the Python executable.  You can use the command name if this version
123
122
is on your ``PATH``::
124
123
 
125
 
    % virtualenv --system-site-packages --python=python2.7 /tmp/py27
 
124
    % virtualenv --system-site-packages --python=python3.4 /tmp/mm3
126
125
 
127
 
or you may specify the full path to any Python 2.7 executable.
 
126
or you may specify the full path to any Python 3.4 executable.
128
127
 
129
128
Now, activate the virtual environment and set it up for development::
130
129
 
131
 
    % source /tmp/py27/bin/activate
 
130
    % source /tmp/mm3/bin/activate
132
131
    % python setup.py develop
133
132
 
134
133
Sit back and have some Kombucha while you wait for everything to download and