Skip to content

Commit 1de94e2

Browse files
author
Stefan Schneider
committed
update readme for v1
1 parent d8753bd commit 1de94e2

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,17 @@ Logging floats easily bloats your logs through many floating point digits?
1111
For example:
1212

1313
```python
14-
log.msg("Important logging", a=1/3, b=2/3)
14+
log.msg("Hello world", a=1/3, b=2/3, ab_list=[1/3, 2/3])
1515

1616
# without structlog-round: prints long and ugly floats
17-
# 2020-07-16 21:48.21 Important logging a=0.3333333333333333 b=0.6666666666666666
17+
# 2020-07-16 21:48.21 Hello world a=0.3333333333333333 b=0.6666666666666666 ab_list=[0.3333333333333333, 0.6666666666666666]
1818

1919
# with structlog-round: floats are logged nicely rounded
20-
# 2020-07-16 21:48.21 Important logging a=0.333 b=0.667
20+
# 2020-07-16 21:48.21 Hello world a=0.333 b=0.667 ab_list=[0.333, 0.667]
2121
```
2222

23-
Easier to read:
24-
25-
26-
23+
`structlog-round` lets you configure how floats are rounded and also supports rounding floats in (nested) lists, dicts, or `numpy` arrays.
24+
2725
## Install
2826

2927
```

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
setup(
1717
name='structlog-round',
1818
author='Stefan Schneider',
19-
version=0.1,
19+
version=1.0,
2020
description="A light-weight structlog processor to round floats for prettier logging.",
2121
long_description=long_description,
2222
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)