summaryrefslogtreecommitdiff
path: root/plac/README.txt
blob: 6c5d887602767a703fb27e9c076fce4b85eed7f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
plac, the easiest command line arguments parser in the world
============================================================

:Author: Michele Simionato
:E-mail: michele.simionato@gmail.com
:Requires: Python 2.3+
:Download page: http://pypi.python.org/pypi/plac
:Installation: ``easy_install plac``
:License: BSD license

Installation
-------------

If you are lazy, just perform

::

 $ easy_install plac

which will install just the module on your system. Notice that
Python 3 requires the easy_install version of the distribute_ project.

If you prefer to install the full distribution from source, including
the documentation, download the tarball_, unpack it and run

::

 $ python setup.py install

in the main directory, possibly as superuser.

.. _tarball: http://pypi.python.org/pypi/plac
.. _distribute: http://packages.python.org/distribute/

Testing
--------

Run

::

 $ python test_plac.py

or

::

 $ nosetests test_plac.py

or

::

 $ py.test test_plac.py

Documentation
--------------

You can choose between the `HTML version`_  and the `PDF version`_ .

.. _HTML version: http://micheles.googlecode.com/hg/plac/doc/plac.html
.. _PDF version: http://micheles.googlecode.com/hg/plac/doc/plac.pdf