@@ -13,18 +13,26 @@ Purpose of the project
13
13
======================
14
14
15
15
.. TODO Explain WHY someone would want to have their code be Python 2/3 compatible
16
-
17
- This library is a very thin wrapper around `` fissix `` to utilize it
16
+ This library is a very thin wrapper around ` fissix
17
+ <https://github.com/jreese/fissix> `_, a fork of lib2to3, to utilize it
18
18
to make Python 2 code more modern with the intention of eventually
19
19
porting it over to Python 3.
20
20
21
- The ``python -m modernize `` command works like `fissix
22
- <https://github.com/jreese/fissix> `_. Here's how you'd rewrite a
21
+ The ``python -m modernize `` command works like
22
+ ``python -m fissix ``, see `fissix <https://github.com/jreese/fissix >`_.
23
+ Here's how you'd rewrite a
23
24
single file::
24
25
25
26
python -m modernize -w example.py
26
27
27
- See the ``LICENSE `` file for the license of ``python -m modernize ``.
28
+ It does not guarantee, but it attempts to spit out a codebase compatible
29
+ with Python 2.6+ or Python 3. The code that it generates has a runtime
30
+ dependency on `six <https://pypi.python.org/pypi/six >`_, unless the
31
+ ``--no-six `` option is used. Version 1.9.0 or later of ``six `` is
32
+ recommended. Some of the fixers output code that is not compatible with
33
+ Python 2.5 or lower.
34
+
35
+ See the ``LICENSE `` file for the license of ``modernize ``.
28
36
Using this tool does not affect licensing of the modernized code.
29
37
30
38
The `project website `_ can be found on GitHub and the PyPI project name is
0 commit comments