diff options
| author | Michele Simionato <michele.simionato@gmail.com> | 2015-03-16 11:13:06 +0100 |
|---|---|---|
| committer | Michele Simionato <michele.simionato@gmail.com> | 2015-03-16 11:13:06 +0100 |
| commit | 5d0a05302b850386b2b71ff281c58db333ac7e78 (patch) | |
| tree | e8ccc92a2336ee1a5bed53a503776888a3929e91 /README.rst | |
| parent | 3e2bd43069fa1837d77f8ab2079044a44aaedd66 (diff) | |
| download | python-decorator-git-5d0a05302b850386b2b71ff281c58db333ac7e78.tar.gz | |
Initial changes for decorator 3.4.1
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..82acddb --- /dev/null +++ b/README.rst @@ -0,0 +1,78 @@ +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
+
+$ pip install decorator
+
+which will install just the module on your system.
+
+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 GitHub. You can look at the source here:
+
+ https://github.com/micheles/decorator
|