doc/download/index.txt

   1 .. -*- rst-mode -*-
   2
   3 Requirements
   4 ============
   5
   6 * Python_ version 2.7 or newer (`download Python`_).
   7
   8
   9 Download
  10 ========
  11
  12 Get the most up to date version from the `Git repository`_
  13 or a release from PyPi_.
  14
  15 PyLit
  16 -----
  17
  18 Download a `repository snapshot`_ as zip file or the single files:
  19
  20 `pylit.py`_
  21   the actual PyLit module,
  22
  23 pylit_
  24   a simple starter and configuration wrapper
  25   (see section Installation_ below),
  26
  27 `pylit_test.py`_
  28   unit tests for the `pylit` module (requires nose_).
  29
  30 .. _Git repository: https://codeberg.org/milde/pylit
  31 .. _Git mirror: http://repo.or.cz/pylit.git
  32 .. _PyPI: https://pypi.python.org/pypi/pylit
  33 .. _repository snapshot:
  34     https://codeberg.org/milde/pylit/archive/master.zip
  35 .. _pylit.py:
  36     https://codeberg.org/milde/pylit/raw/branch/master/pylit.py
  37 .. _pylit_test.py:
  38     https://codeberg.org/milde/pylit/raw/branch/master/test/pylit_test.py
  39
  40
  41 Tools
  42 -----
  43
  44 * Docutils_ or Sphinx_ for conversion of reStructuredText to HTML or PDF
  45   (not strictly required by PyLit but needed for "pretty printing" the text
  46   source)
  47
  48 * `Editor Support for reStructuredText`_
  49
  50 * `pylit mode`_ for the `JED editor`_
  51
  52 .. _Docutils: https://docutils.sourceforge.io/
  53 .. _Sphinx: https://www.sphinx-doc.org/
  54 .. _`Editor Support for reStructuredText`:
  55     https://docutils.sourceforge.io/tools/editors/README.html
  56 .. _`pylit mode`: https://jedmodes.sourceforge.io/mode/pylit/
  57 .. _`JED editor`: http://www.jedsoft.org/jed/
  58
  59
  60 Installation
  61 ============
  62
  63 The easiest way is to install with pip_ (``pip install pylit``).
  64 This will install the ``pylit.py`` module
  65 and a command line script ``pylit``.
  66
  67
  68 As `PyLit` is a pure Python module, installation "by hand" is
  69 straightforward, too:
  70
  71 *  Put `pylit.py`_ in Python's `Module Search Path`_.
  72
  73    You can now call the script with ::
  74
  75      python -m pylit OPTIONS INFILE [OUTFILE]
  76
  77    or ::
  78
  79      python -m pylit --help
  80
  81 * Easier invocation is possible with a small executable wrapper in the
  82   binary PATH. On Unix you can use a script like `<pylit>`_:
  83
  84   .. include:: pylit
  85      :literal:
  86
  87   This has two advantages:
  88
  89   #. `Command line use`_ is simplified.
  90   #. `Default settings`_ can be customised without changing the module file.
  91
  92 .. _Python: https://www.python.org
  93 .. _Download Python: https://www.python.org/downloads/
  94 .. _nose: https://pypi.org/project/nose/
  95 .. _module search path:
  96     https://docs.python.org/3/tutorial/modules.html#the-module-search-path
  97 .. _command line use: ../usage.html#command-line-use
  98 .. _default settings: ../usage.html#defaults
  99 .. _pip: https://pip.pypa.io/en/stable/