1
- Log formatting with colors!
2
- ===========================
1
+ # Log formatting with colors!
3
2
4
3
[ ![ ] ( https://img.shields.io/pypi/v/colorlog.svg )] ( https://pypi.org/project/colorlog/ )
5
4
[ ![ ] ( https://img.shields.io/pypi/l/colorlog.svg )] ( https://pypi.org/project/colorlog/ )
@@ -9,8 +8,7 @@ Add colours to the output of Python's `logging` module.
9
8
* [ Source on GitHub] ( https://github.com/borntyping/python-colorlog )
10
9
* [ Packages on PyPI] ( https://pypi.org/pypi/colorlog/ )
11
10
12
- Status
13
- ------
11
+ ## Status
14
12
15
13
colorlog currently requires Python 3.6 or higher. Older versions (below 5.x.x)
16
14
support Python 2.6 and above.
@@ -30,8 +28,7 @@ requests. colorlog 4 might accept essential bugfixes but should not be
30
28
considered actively maintained and will not accept any major changes or new
31
29
features.
32
30
33
- Installation
34
- ------------
31
+ ## Installation
35
32
36
33
Install from PyPI with:
37
34
@@ -43,8 +40,7 @@ Several Linux distributions provide official packages ([Debian], [Arch], [Fedora
43
40
[ Gentoo] , [ OpenSuse] and [ Ubuntu] ), and others have user provided packages
44
41
([ BSD ports] , [ Conda] ).
45
42
46
- Usage
47
- -----
43
+ ## Usage
48
44
49
45
``` python
50
46
import colorlog
@@ -107,8 +103,7 @@ support for these varies wildly across different terminals.
107
103
- ` light_cyan `
108
104
- ` light_white `
109
105
110
- Examples
111
- --------
106
+ ## Examples
112
107
113
108
![ Example output] ( doc/example.png )
114
109
@@ -211,37 +206,32 @@ logger.setLevel('TRACE')
211
206
logger.log(TRACE , ' a message using a custom level' )
212
207
```
213
208
214
- Tests
215
- -----
209
+ ## Tests
216
210
217
211
Tests similar to the above examples are found in ` tests/test_colorlog.py ` .
218
212
219
- Status
220
- ------
213
+ ## Status
221
214
222
215
colorlog is in maintenance mode. I try and ensure bugfixes are published,
223
216
but compatibility with Python 2.6+ and Python 3+ makes this a difficult
224
217
codebase to add features to. Any changes that might break backwards
225
218
compatibility for existing users will not be considered.
226
219
227
- Alternatives
228
- ------------
220
+ ## Alternatives
229
221
230
222
There are some more modern libraries for improving Python logging you may
231
223
find useful.
232
224
233
225
- [ structlog]
234
226
- [ jsonlog]
235
227
236
- Projects using colorlog
237
- -----------------------
228
+ ## Projects using colorlog
238
229
239
230
GitHub provides [ a list of projects that depend on colorlog] [ dependents ] .
240
231
241
232
Some early adopters included [ Errbot] , [ Pythran] , and [ zenlog] .
242
233
243
- Licence
244
- -------
234
+ ## Licence
245
235
246
236
Copyright (c) 2012-2021 Sam Clements < sam@borntyping.co.uk >
247
237
0 commit comments