From b09d6c91685b18369eb1c72281e5f372cbbe8d6e Mon Sep 17 00:00:00 2001 From: Inada Naoki Date: Wed, 28 Feb 2024 19:51:27 +0900 Subject: [PATCH] update readme Signed-off-by: Inada Naoki --- README.rst | 36 ++++++++++++++---------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 5a31463..30b499f 100644 --- a/README.rst +++ b/README.rst @@ -1,20 +1,12 @@ -A Python structured logger for Fluentd -====================================== - -.. image:: https://travis-ci.org/fluent/fluent-logger-python.svg?branch=master - :target: https://travis-ci.org/fluent/fluent-logger-python - :alt: Build Status - -.. image:: https://coveralls.io/repos/fluent/fluent-logger-python/badge.svg - :target: https://coveralls.io/r/fluent/fluent-logger-python - :alt: Coverage Status +A Python structured logger for Fluentd/Fluent Bit +================================================= Many web/mobile applications generate huge amount of event logs (c,f. login, logout, purchase, follow, etc). To analyze these event logs could be really valuable for improving the service. However, the challenge is collecting these logs easily and reliably. -`Fluentd `__ solves that problem by +`Fluentd `__ and `Fluent Bit `__ solves that problem by having: easy installation, small footprint, plugins, reliable buffering, log forwarding, etc. @@ -24,10 +16,11 @@ Python application. Requirements ------------ -- Python 3.5+ +- Python 3.7+ - ``msgpack`` - **IMPORTANT**: Version 0.8.0 is the last version supporting Python 2.6, 3.2 and 3.3 - **IMPORTANT**: Version 0.9.6 is the last version supporting Python 2.7 and 3.4 +- **IMPORTANT**: Version 0.10.0 is the last version supporting Python 3.5 and 3.6 Installation ------------ @@ -366,23 +359,22 @@ that this doesn't happen, or it's acceptable for your application. Testing ------- -Testing can be done using -`nose `__. - -Release -------- - -Need wheel package. +Testing can be done using `pytest `__. .. code:: sh - $ pip install wheel + $ pytest tests -After that, type following command: + +Release +------- .. code:: sh - $ python setup.py clean sdist bdist_wheel upload + $ # Download dist.zip for release from GitHub Action artifact. + $ unzip -d dist dist.zip + $ pipx twine upload dist/* + Contributors ------------