contextfilter 0.2.0

ContextVars Filter for easily enriching log records

contextfilter

Small, helper library for logging contextual information in Python 3.7.

Installation

Using pip

$ pip install contextfilter

Usage

import logging
from contextfilter import ContextFilter, set_entry, set_entries

logger = logging.getLogger("test")
logger.addFilter(ContextFilter())
set_entry("request_id", 3)
# or
set_entries(request_id=3)
logger.info("test")
# Log record will contain the attribute request_id with value 3

Contributing

To work on the contextfilter codebase, you'll want to fork the project and clone it locally and install the required dependencies via poetry:

$ git clone [e-mail]:{USER}/contextfilter.git
$ make install

To run tests and linters use command below:

$ make lint && make test

If you want to run only tests or linters you can explicitly specify which test environment you want to run, e.g.:

$ make lint-black

License

contextfilter is licensed under the MIT license. See the license file for details.