~ubuntu-branches/debian/sid/python-decorator/sid

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Piotr Ożarowski
  • Date: 2010-05-25 21:55:03 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20100525215503-4xq1iyhjijh0t8o6
Tags: 3.2.0-1
* New upstream release
  - changelog no longer available
* python added to Build-Depends (clean rule needs it)
* debian/watch file points to PyPI now

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Decorator module
2
 
---------------------------
3
 
 
4
 
Dependencies:
5
 
 
6
 
The decorator module requires Python 2.4.
7
 
 
8
 
Installation:
9
 
 
10
 
Copy the file decorator.py somewhere in your Python path.
11
 
 
12
 
Testing:
13
 
 
14
 
Run
 
2
=================
 
3
 
 
4
 
 
5
:Author: Michele Simionato
 
6
:E-mail: michele.simionato@gmail.com
 
7
:Requires: Python 2.4+
 
8
:Download page: http://pypi.python.org/pypi/decorator
 
9
:Installation: ``easy_install decorator``
 
10
:License: BSD license
 
11
 
 
12
Installation
 
13
-------------
 
14
 
 
15
If you are lazy, just perform
 
16
 
 
17
$ easy_install decorator
 
18
 
 
19
which will install just the module on your system. Notice that
 
20
Python 3 requires the easy_install version of the distribute_ project.
 
21
 
 
22
If you prefer to install the full distribution from source, including
 
23
the documentation, download the tarball_, unpack it and run
 
24
 
 
25
$ python setup.py install
 
26
 
 
27
in the main directory, possibly as superuser.
 
28
 
 
29
.. _tarball: http://pypi.python.org/pypi/decorator
 
30
.. _distribute: http://packages.python.org/distribute/
 
31
 
 
32
Testing
 
33
--------
 
34
 
 
35
For Python 2.5, 2.6, 2.7 run
15
36
 
16
37
$ python documentation.py
17
38
 
18
 
This should work perfectly with Python 2.4 and Python 2.5 and give
19
 
minor errors with Python 2.6 (some inner details such as the
20
 
introduction of the ArgSpec namedtuple and Thread.__repr__ changed).
 
39
for Python 3.X run
 
40
 
 
41
$ python documentation3.py
 
42
 
 
43
You will see a few innocuous errors with Python 2.5, because some
 
44
inner details such as the introduction of the ArgSpec namedtuple and
 
45
Thread.__repr__ changed. You may safely ignore them. 
 
46
 
 
47
You cannot run the tests in Python 2.4, since there is a test using
 
48
the with statement, but the decorator module is expected to work
 
49
anyway (it has been used in production with Python 2.4 for years). My
 
50
plan is to keep supporting all Python versions >= 2.4 in the core
 
51
module, but I will keep the documentation and the tests updated only
 
52
for the latest Python versions in both the 2.X and 3.X branches.
 
53
 
 
54
Finally, notice that you may run into trouble if in your system there
 
55
is an older version of the decorator module; in such a case remove the
 
56
old version.
 
57
 
 
58
Documentation
 
59
--------------
 
60
 
 
61
There are various versions of the documentation:
 
62
 
 
63
-  `HTML version (Python 2)`_ 
 
64
-  `PDF version (Python 2)`_ 
 
65
 
 
66
-  `HTML version (Python 3)`_ 
 
67
-  `PDF version (Python 3)`_ 
 
68
 
 
69
.. _HTML version (Python 2): http://micheles.googlecode.com/hg/decorator/documentation.html
 
70
.. _PDF version (Python 2): http://micheles.googlecode.com/hg/decorator/documentation.pdf
 
71
.. _HTML version (Python 3): http://micheles.googlecode.com/hg/decorator/documentation3.html
 
72
.. _PDF version (Python 3): http://micheles.googlecode.com/hg/decorator/documentation3.pdf