README.txt


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
63

Decorator module
=================


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

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

If you are lazy, just perform

$ easy_install decorator

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/decorator
.. _distribute: http://packages.python.org/distribute/

Testing
--------

For Python 2.4, 2.5, 2.6, 2.7 run

$ python documentation.py

for Python 3.X run

$ python documentation3.py

You will see a few innocuous errors with Python 2.4 and 2.5, because
some inner details such as the introduction of the ArgSpec namedtuple 
and Thread.__repr__ changed. You may safely ignore them.
Notice that you may run into trouble if in your system there is an older version
of the decorator module; in such a case remove the old version.

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

There are various versions of the documentation:

-  `HTML version (Python 2)`_ 
-  `PDF version (Python 2)`_ 

-  `HTML version (Python 3)`_ 
-  `PDF version (Python 3)`_ 

.. _HTML version (Python 2): http://micheles.googlecode.com/hg/decorator/documentation.html
.. _PDF version (Python 2): http://micheles.googlecode.com/hg/decorator/documentation.pdf
.. _HTML version (Python 3): http://micheles.googlecode.com/hg/decorator/documentation3.html
.. _PDF version (Python 3): http://micheles.googlecode.com/hg/decorator/documentation3.pdf