github/sprockets.logging
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.logging.git synced 2024-11-21 19:28:35 +00:00
Code Issues Projects Releases Packages Wiki Activity
Making logs nicer since 2015!
5 commits 1 branch 8 tags 117 KiB
Python 100%
Find a file
Dave Shawley 9a3e3dd897 README: Adjust badges slightly. 
The pypip.in badges have been less than reliable of late.  Now all of
the badges are pointed to ones provided by the service provider.  They
have a vested interest in maintaining them, so let's use them instead.
2015-06-09 09:08:40 -04:00
docs Implement sprockets.logging.ContextFilter 2015-06-08 13:58:09 -04:00
examples Add examples. 2015-06-08 13:20:03 -04:00
sprockets Implement sprockets.logging.ContextFilter 2015-06-08 13:58:09 -04:00
.gitignore SYN 2015-06-08 10:18:05 -04:00
.travis.yml Remove requirements files. 2015-06-08 13:59:10 -04:00
LICENSE SYN 2015-06-08 10:18:05 -04:00
MANIFEST.in Remove requirements files. 2015-06-08 13:59:10 -04:00
README.rst README: Adjust badges slightly. 2015-06-09 09:08:40 -04:00
setup.cfg SYN 2015-06-08 10:18:05 -04:00
setup.py Remove requirements files. 2015-06-08 13:59:10 -04:00
tests.py Implement sprockets.logging.ContextFilter 2015-06-08 13:58:09 -04:00
tox.ini Remove requirements files. 2015-06-08 13:59:10 -04:00

README.rst 

sprockets.logging
=================
Making logs nicer since 2015!

|Version| |Downloads| |Travis| |CodeCov| |ReadTheDocs|

Installation
------------
``sprockets.logging`` is available on the
`Python Package Index <https://pypi.python.org/pypi/sprockets.logging>`_
and can be installed via ``pip`` or ``easy_install``:

.. code-block:: bash

   pip install sprockets.logging

Documentation
-------------
https://sprocketslogging.readthedocs.org

Requirements
------------
-  No external requirements

Example
-------
This examples demonstrates the most basic usage of ``sprockets.logging``

.. code-block:: python

   import logging
   import sys

   import sprockets.logging


   formatter = logging.Formatter('%(levelname)s %(message)s {%(context)s}')
   handler = logging.StreamHandler(sys.stdout)
   handler.setFormatter(formatter)
   handler.addFilter(sprockets.logging.ContextFilter(properties=['context']))
   logging.Logger.root.addHandler(handler)
   logging.Logger.root.setLevel(logging.DEBUG)

   # Outputs: INFO Hi there {None}
   logging.info('Hi there')

   # Outputs: INFO No KeyError {bah}
   logging.info('No KeyError', extra={'context': 'bah'})

   # Outputs: INFO Now with context! {foo}
   adapted = logging.LoggerAdapter(logging.Logger.root, extra={'context': 'foo'})
   adapted.info('Now with context!')

Source
------
``sprockets.logging`` source is available on Github at `https://github.com/sprockets/sprockets.logging <https://github.com/sprockets/sprockets.logging>`_

License
-------
``sprockets.logging`` is released under the `3-Clause BSD license <https://github.com/sprockets/sprockets.logging/blob/master/LICENSE>`_.


.. |Version| image:: https://badge.fury.io/py/sprockets.logging.svg?
   :target: http://badge.fury.io/py/sprockets.logging

.. |Travis| image:: https://travis-ci.org/sprockets/sprockets.logging.svg?branch=master
   :target: https://travis-ci.org/sprockets/sprockets.logging

.. |CodeCov| image:: http://codecov.io/github/sprockets/sprockets.logging/coverage.svg?branch=master
   :target: https://codecov.io/github/sprockets/sprockets.logging?branch=master

.. |Downloads| image:: https://pypip.in/d/sprockets.logging/badge.svg?
   :target: https://pypi.python.org/pypi/sprockets.logging

.. |ReadTheDocs| image:: https://readthedocs.org/projects/sprocketslogging/badge/
   :target: https://sprocketslogging.readthedocs.org