summaryrefslogtreecommitdiff
path: root/plac/README.txt
blob: b99db3b58b6dee67ef5ccb5c9b5ac4c5015a0922 (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
Installation
-------------

If you are lazy, just perform

::

 $ easy_install -U plac

which will install the module on your system (and possibly argparse
too, if it is not already installed). 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 doc/test_plac.py

or

::

 $ nosetests doc

or

::

 $ py.test doc

Some tests will fail if sqlalchemy is not installed. 
Run an ``easy_install -U sqlalchemy`` or just ignore them.

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

The source code and the documentation are hosted on Google code.
Here is the full documentation in HTML and PDF form:

http://micheles.googlecode.com/hg/plac/doc/plac.html

http://micheles.googlecode.com/hg/plac/doc/plac.pdf