DESCRIPTION.rst 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. Decorator module
  2. =================
  3. :Author: Michele Simionato
  4. :E-mail: michele.simionato@gmail.com
  5. :Requires: Python from 2.6 to 3.6
  6. :Download page: http://pypi.python.org/pypi/decorator
  7. :Installation: ``pip install decorator``
  8. :License: BSD license
  9. Installation
  10. -------------
  11. If you are lazy, just perform
  12. `$ pip install decorator`
  13. which will install just the module on your system.
  14. If you prefer to install the full distribution from source, including
  15. the documentation, clone the `GitHub repo`_ or download the tarball_, unpack it and run
  16. `$ pip install .`
  17. in the main directory, possibly as superuser.
  18. .. _tarball: http://pypi.python.org/pypi/decorator
  19. .. _GitHub repo: https://github.com/micheles/decorator
  20. Testing
  21. --------
  22. If you have the source code installation you can run the tests with
  23. `$ python src/tests/test.py -v`
  24. or (if you have setuptools installed)
  25. `$ python setup.py test`
  26. Notice that you may run into trouble if in your system there
  27. is an older version of the decorator module; in such a case remove the
  28. old version. It is safe even to copy the module `decorator.py` over
  29. an existing one, since we kept backward-compatibility for a long time.
  30. Repository
  31. ---------------
  32. The project is hosted on GitHub. You can look at the source here:
  33. https://github.com/micheles/decorator
  34. Documentation
  35. ---------------
  36. The documentation has been moved to http://decorator.readthedocs.io/en/stable/
  37. You can download a PDF version of it from http://media.readthedocs.org/pdf/decorator/stable/decorator.pdf