feat: update README, add install section
This commit is contained in:
parent
5b600828f6
commit
4054f62e44
2 changed files with 6 additions and 2 deletions
|
|
@ -8,6 +8,12 @@
|
||||||
|
|
||||||
Async-compatible, dependency-less, simple log suppression and filtering lib
|
Async-compatible, dependency-less, simple log suppression and filtering lib
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pip install shushlog
|
||||||
|
```
|
||||||
|
|
||||||
## TLDR
|
## TLDR
|
||||||
|
|
||||||
- supress all logs
|
- supress all logs
|
||||||
|
|
@ -21,7 +27,6 @@ Async-compatible, dependency-less, simple log suppression and filtering lib
|
||||||
>>> @shush.suppress
|
>>> @shush.suppress
|
||||||
>>> def suppressed_func():
|
>>> def suppressed_func():
|
||||||
>>> logger.info("this should not be logged")
|
>>> logger.info("this should not be logged")
|
||||||
>>> @shush.suppress
|
|
||||||
>>> def normal_func():
|
>>> def normal_func():
|
||||||
>>> logger.info("this should be logged")
|
>>> logger.info("this should be logged")
|
||||||
>>> suppressed_func()
|
>>> suppressed_func()
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,6 @@ def suppress(func):
|
||||||
>>> @shush.suppress
|
>>> @shush.suppress
|
||||||
>>> def suppressed_func():
|
>>> def suppressed_func():
|
||||||
>>> logger.info("this should not be logged")
|
>>> logger.info("this should not be logged")
|
||||||
>>> @shush.suppress
|
|
||||||
>>> def normal_func():
|
>>> def normal_func():
|
||||||
>>> logger.info("this should be logged")
|
>>> logger.info("this should be logged")
|
||||||
>>> suppressed_func()
|
>>> suppressed_func()
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue