|
6 years ago | |
---|---|---|
docs | 6 years ago | |
flask_logging_extras | 6 years ago | |
tests | 6 years ago | |
.gitignore | 6 years ago | |
.travis.yml | 6 years ago | |
README.rst | 6 years ago | |
docs-requirements.txt | 6 years ago | |
setup.py | 6 years ago | |
tox.ini | 6 years ago |
README.rst
Flask-Logging-Extras
Flask-Logging-Extras adds additional logging features for Flask applications.
The only feature implemented now is adding extra arguments to the format string, like this (this example adds the category keyword to the logs:
= '[%(asctime)s] [%(levelname)s] [%(category)s] %(message'
fmt # Initialize log handlers as usual, like creating a FileHandler, and
# assign fmt to it as a format string
'FLASK_LOGGING_EXTRAS_KEYWORDS'] = {'category': '<unset>'}
app.config[
app.logger.init_app(app)
'this is the message, as usual',
current_app.logger.info(='fancy-category') category
Installation
The easiest way to start using the package is with pip:
$ pip install Flask-Logging-Extras
If you prefer to install from source, you can clone this repo and run
$ python setup.py install
Usage
Testing and Code Coverage
We require 100% code coverage in our unit tests. We run all the unit tests with tox, which will test against python2.7, 3.3, 3.4, and 3.5.
Running tox will print out a code coverage report. Coverage report is also available on codecov.
tox is running automatically for every push in Travis-CI. To run tox on your local machine, you can simply invoke it with the tox command.
Generating Documentation
You can generate a local copy of the documentation. First, make sure you have the flask sphinx theme available. You can get it (and all possible documentation requirements) with
$ pip install -r docs-requirements.txt
Then in the docs/ directory, run
$ make clean && make html
License
This module is available under the BSD license.