From b02f7a254c3679dfac57a824e08dd02ced850636 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Thu, 18 Oct 2012 08:53:16 +0000 Subject: Imported from /home/lorry/working-area/delta_python-packages_python-decorator/decorator-3.4.0.tar.gz. --- README.txt | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 README.txt (limited to 'README.txt') diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..50b39c1 --- /dev/null +++ b/README.txt @@ -0,0 +1,80 @@ +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.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.5, because some +inner details such as the introduction of the ArgSpec namedtuple and +Thread.__repr__ changed. You may safely ignore them. + +You cannot run the tests in Python 2.4, since there is a test using +the with statement, but the decorator module is expected to work +anyway (it has been used in production with Python 2.4 for years). My +plan is to keep supporting all Python versions >= 2.4 in the core +module, but I will keep the documentation and the tests updated only +for the latest Python versions in both the 2.X and 3.X branches. + +Finally, 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 + +Repository +--------------- + +The project is hosted on GoogleCode as a Mercurial repository. You +can look at the source here: + + http://code.google.com/p/micheles/source/browse/#hg%2Fdecorator -- cgit v1.2.1