diff options
author | Aaron Iles <aaron.iles@gmail.com> | 2013-01-06 21:23:25 +1100 |
---|---|---|
committer | Aaron Iles <aaron.iles@gmail.com> | 2013-01-06 21:23:25 +1100 |
commit | a3eb229b0700949bbac9d071b9a62383fd5b7237 (patch) | |
tree | 7d2c014bdac35cbea8419f24239926050fb7c108 /README.rst | |
parent | 7e16c79cd4b5bbe5b0a177fbdef4a7f27bfa1940 (diff) | |
download | funcsigs-a3eb229b0700949bbac9d071b9a62383fd5b7237.tar.gz |
Update README documentation
Complete the README documentation with project details for funcsigs.
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 52 |
1 files changed, 52 insertions, 0 deletions
@@ -1,2 +1,54 @@ funcsigs ======== + +``funcsigs`` is a backport of the `PEP 362`_ function signature features from +Python 3.3's `inspect`_ module. The backport is compatible with Python 2.6, 2.7 +as well as 3.2 and up. + +Documentation +------------- + +The reference documentation is standard library documentation for the +`inspect`_ module in Python3. This documentation has been included in the +``funcsigs`` package documentation hosted on `Read The Docs`_. + +Compatability +------------- + +The ``funcsigs`` backport has been tested against: + +* CPython 2.6 +* CPython 2.7 +* CPython 3.2 + +Continuous integration testing is provided by `Travis CI`_. + +There is one known compatability issue with Python 2.x when a function is +assigned to the ``__wrapped__`` property of a class after it has been +constructed. Otherwise the functionality is believed to be uniform between both +Python2 and Python3. + +Issues +------ + +Source code for ``funcsigs`` is hosted on `GitHub`_. Any bug reports or feature +requests can be made using GitHub's `issues system`_. |build_status| + +Copyright +--------- + +This is a derived work of CPython under the terms of the `PSF License +Agreement`_. The original CPython inspect module and its unit tests are the +copyright of the Python Software Foundation. The derived work is distributed +under the `Apache License Version 2.0`_. + +.. _Apache License Version 2.0: http://opensource.org/licenses/Apache-2.0 +.. _GitHub: https://github.com/aliles/funcsigs +.. _PSF License Agreement: http://docs.python.org/3/license.html#terms-and-conditions-for-accessing-or-otherwise-using-python +.. _Travis CI: http://travis-ci.org/ +.. _Read The Docs: http://funcsigs.readthedocs.org/ +.. _PEP 362: http://www.python.org/dev/peps/pep-0362/ +.. _inspect: http://docs.python.org/3/library/inspect.html#introspecting-callables-with-the-signature-object +.. _issues system: https://github.com/alies/funcsigs/issues +.. |build_status| image:: https://secure.travis-ci.org/aliles/funcsigs.png?branch=master + :target: http://travis-ci.org/#!/aliles/funcsigs |