Skip to content

Commit

Permalink
Some doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
nir0s committed Mar 20, 2018
1 parent 3b82236 commit e398531
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Wryte
[![Code Quality](https://landscape.io/github/nir0s/wryte/master/landscape.svg?style=flat)](https://landscape.io/github/nir0s/wryte)
[![Is Wheel](https://img.shields.io/pypi/wheel/wryte.svg?style=flat)](https://pypi.python.org/pypi/wryte)

Note that the following documentation relates to the code currently in the master branch. If you want to view docs for previous versions, please choose the relevant release in the "releases" tab.
Wryte aims to provide a simple API for logging in Python adhering to logging principles fitting today's systems.

## Features
Note that the following documentation relates to the code currently in the master branch. If you want to view docs for previous versions, please choose the relevant release in the "releases" tab.

Wryte aims to provide a simple API for logging in Python:
## Notable Features and design principles

* Very easy to get started
* Sane defaults!
Expand All @@ -29,7 +29,7 @@ Wryte aims to provide a simple API for logging in Python:
* Context binding to prevent repetition
* Retroactive logging (WIP)
* Assist in user tracing (via auto-provided context ids)
* Zero exceptions. There should be zero logging exceptions causing the app to crash but rather Wryte should log errors whenever logging errors occur.
* Zero logging exceptions. There should be zero logging exceptions causing the app to crash but rather Wryte should log errors whenever logging errors occur.

The main premise is that a standard CLI application logs to the console, while a server side app will probably want to log some human readable messages to syslog/console while logging JSON containing the same information with some additional contextual information over the wire (to a log aggregation backend e.g. ELK/Graylog2)

Expand Down

0 comments on commit e398531

Please sign in to comment.