<commit_before>========================================================================
Autologging --- easier logging and tracing for classes
========================================================================

HOMEPAGE:
   http://www.ninthtest.net/python-autologging/

AUTHOR:
   <NAME> <<EMAIL>>

LICENSE:
   MIT License (see the LICENSE.txt file)

Python 2.7, 3.2, 3.3, 3.4

------------------------------------------------------------------------
INTRODUCTION
------------------------------------------------------------------------

Autologging provides two decorators and a metaclass factory:

**@logged**
   Decorate a class (or function) to create a ``__logger`` member.
   The logger is automatically named to match the dotted-name of the
   class or module.
   Alternatively, provide a specific logger using ``@logged(logger)``.

**@traced**
   Decorate a module-level function to provide call/return tracing.
   The log record attributes *pathname*, *filename*, *lineno*, *module*,
   and *funcName* work as expected (i.e. they refer to the original
   function, NOT the proxy function returned by the decorator).

**TracedMethods**
   Create a metaclass that adds automatic tracing to specified class
   methods (just like @traced does for module-level functions).
   The log record attributes *pathname*, *filename*, *lineno*, *module*,
   and *funcName* work as expected (i.e. they refer to the original
   class method, NOT the proxy method installed by the metaclass).

Additionally, the ``autologging`` module defines and registers a custom
log level named "TRACE" (level 1) so that tracing messages can be
toggled on/off independently of DEBUG-level logging.

------------------------------------------------------------------------
DOWNLOAD / INSTALL
------------------------------------------------------------------------

There are three options to download/install Autologging:

* Use "pip install Autologging"

* Download a source or built distribution from
  http://sourceforge.net/projects/autologging/files/autologging/
  and run either "python setup.py" or the binary installer

* Clone the Mercurial repository from
  https://bitbucket.org/mzipay/autologging and run "python setup.py"

If you download or clone the source, the test suite can be run from the
project root directory in either of the following ways:

	python -m unittest test.suite

	python setup.py test
<commit_msg>README.txt edited online with Bitbucket<commit_after>========================================================================
Autologging --- easier logging and tracing for classes
========================================================================

HOMEPAGE:
   http://www.ninthtest.net/python-autologging/

AUTHOR:
   <NAME> <<EMAIL>>

LICENSE:
   MIT License (see the LICENSE.txt file)

Python 2.7, 3.2, 3.3, 3.4

------------------------------------------------------------------------
INTRODUCTION
------------------------------------------------------------------------

Autologging provides two decorators and a metaclass factory:

**@logged**
   Decorate a class (or function) to create a ``__logger`` member.
   The logger is automatically named to match the dotted-name of the
   class or module.
   Alternatively, provide a specific logger using ``@logged(logger)``.

**\@traced**
   Decorate a module-level function to provide call/return tracing.
   The log record attributes *pathname*, *filename*, *lineno*, *module*,
   and *funcName* work as expected (i.e. they refer to the original
   function, NOT the proxy function returned by the decorator).

**TracedMethods**
   Create a metaclass that adds automatic tracing to specified class
   methods (just like @traced does for module-level functions).
   The log record attributes *pathname*, *filename*, *lineno*, *module*,
   and *funcName* work as expected (i.e. they refer to the original
   class method, NOT the proxy method installed by the metaclass).

Additionally, the ``autologging`` module defines and registers a custom
log level named "TRACE" (level 1) so that tracing messages can be
toggled on/off independently of DEBUG-level logging.

------------------------------------------------------------------------
DOWNLOAD / INSTALL
------------------------------------------------------------------------

There are three options to download/install Autologging:

* Use "pip install Autologging"

* Download a source or built distribution from
  http://sourceforge.net/projects/autologging/files/autologging/
  and run either "python setup.py" or the binary installer

* Clone the Mercurial repository from
  https://bitbucket.org/mzipay/autologging and run "python setup.py"

If you download or clone the source, the test suite can be run from the
project root directory in either of the following ways:

	python -m unittest test.suite

	python setup.py test
{'fraction_non_alphanumeric': 0.24413338822560723, 'fraction_numerical': 0.0037052284890901604, 'mean_word_length': 2.588626292466765, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '281090', 'n_tokens_mistral': 1189, 'n_tokens_neox': 1145, 'n_words': 502}