aboutsummaryrefslogtreecommitdiffstats
path: root/README.py3k
diff options
context:
space:
mode:
Diffstat (limited to 'README.py3k')
-rw-r--r--README.py3k50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.py3k b/README.py3k
new file mode 100644
index 0000000..3e3c8ab
--- /dev/null
+++ b/README.py3k
@@ -0,0 +1,50 @@
+=================
+PYTHON 3 SUPPORT
+=================
+
+Python 3 support in Mako is provided by the Python 2to3 script.
+
+Installing Distribute
+---------------------
+
+Distribute should be installed with the Python3 installation. The
+distribute bootloader is included.
+
+Running as a user with permission to modify the Python distribution,
+install Distribute:
+
+ python3 distribute_setup.py
+
+
+Installing Mako in Python 3
+---------------------------------
+
+Once Distribute is installed, Mako can be installed directly.
+The 2to3 process will kick in which takes several minutes:
+
+ python3 setup.py install
+
+Converting Tests, Examples, Source to Python 3
+----------------------------------------------
+
+To convert all files in the source distribution, run
+the 2to3 script:
+
+ 2to3 --no-diffs -w lib test examples
+
+The above will rewrite all files in-place in Python 3 format.
+
+Running Tests
+-------------
+
+To run the unit tests, ensure Distribute is installed as above,
+and also that at least the ./lib/ and ./test/ directories have been converted
+to Python 3 using the source tool above. A Python 3 version of Nose
+can be acquired from Bitbucket using Mercurial:
+
+ hg clone http://bitbucket.org/jpellerin/nose3/
+ cd nose3
+ python3 setup.py install
+
+The tests can then be run using the "nosetests3" script installed by the above.
+