.. -*- rst-mode -*-

Requirements
============

* Python_ version 2.4 or newer.\ [#]_

  If it is missing on your machine, you can get it from
  http://www.python.org/download/

.. [#] Version 2.3 should work as long as you do not use the
       ``--doctest`` option.

Download
========

PyLit
-----
`pylit.py`_
  There are no file releases. You get the most up to date version from
  the `SVN repository`_.

pylit_
  A simple starter and configuration wrapper (see installation_).

`pylit_test.py`_
  unit tests for the `pylit` module

.. _`SVN repository`:
   http://developer.berlios.de/svn/?group_id=7974
.. _`pylit.py`:
   http://svn.berlios.de/svnroot/repos/pylit/trunk/src/pylit.py
.. _pylit_test.py:
   http://svn.berlios.de/svnroot/repos/pylit/trunk/test/pylit_test.py

Tools
-----

* Docutils_ or Sphinx_ for conversion of reStructuredText to HTML or PDF
  (not strictly required by PyLit but needed for "pretty printing" the text
  source)

* `Editor Support for reStructuredText`_

* `pylit functions`_ for the `JED editor`_

.. _Docutils: http://docutils.sourceforge.net/
.. _Sphinx: http://sphinx.pocoo.org/
.. _`Editor Support for reStructuredText`:
   http://docutils.sourceforge.net/tools/editors/README.html
.. _`pylit functions`: http://jedmodes.sourceforge.net/mode/pylit/
.. _`JED editor`: http://www.jedsoft.org/jed/


Installation
============

As `PyLit` is a pure Python module, installation is straightforward:

*  Put `pylit.py`_ in Python's `Module Search Path`_.

   You can now call the script with ::
     
     python -m pylit OPTIONS INFILE [OUTFILE]
     
   or ::
   
     python -m pylit --help  

* Easier invocation is possible with a small executable wrapper in the
  binary PATH. On Unix you can use a script like pylit_:

  .. include:: pylit
     :literal:

  This has two advantages:

  #. `Command line use`_ is simplified.
  #. `Default settings`_ can be customised without changing the module file.

.. _Python: http://www.python.org
.. _module search path:
    http://docs.python.org/tutorial/modules.html#the-module-search-path
.. _pylit: pylit
.. _command line use: ../usage/index.html#command-line-use
.. _default settings: ../usage/index.html#defaults
