Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add README

  • Loading branch information...
commit 22605d9e810fcfbf804ed013e7fa0996cf3ead1f 1 parent 31b8c91
Ben Darnell authored
Showing with 28 additions and 0 deletions.
  1. +28 −0 README.md
28 README.md
View
@@ -0,0 +1,28 @@
+Overview
+========
+
+`auto2to3` is a wrapper to run `2to3` automatically at import time. This is
+useful when developing a library that intends to support both Python 2 and
+Python 3 via `2to3`.
+
+Usage
+=====
+
+`auto2to3.py --package=pkg main_module`
+
+main_module is run as if by the -m flag to the python interpreter
+(i.e. __name__ == '__main__'). All modules whose name begins with a name
+passed to the --package flag (which may be specified more than once)
+will be run through 2to3. 2to3 output is cached on disk between runs
+for speed.
+
+Example
+-------
+
+`auto2to3.py --package=tornado tornado.test.runtests`
+
+Acknowledgements
+================
+
+Based on auto2to3.py by Georg Brandl:
+http://dev.pocoo.org/hg/sandbox/file/tip/auto2to3.py
Please sign in to comment.
Something went wrong with that request. Please try again.