Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Inada Naoki <songofacandy@gmail.com>
  • Loading branch information
methane committed Feb 28, 2024
1 parent d248db5 commit b09d6c9
Showing 1 changed file with 14 additions and 22 deletions.
36 changes: 14 additions & 22 deletions 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 <https://github.com/fluent/fluentd>`__ solves that problem by
`Fluentd <https://github.com/fluent/fluentd>`__ and `Fluent Bit <https://fluentbit.io/>`__ solves that problem by
having: easy installation, small footprint, plugins, reliable buffering,
log forwarding, etc.

Expand All @@ -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
------------
Expand Down Expand Up @@ -366,23 +359,22 @@ that this doesn't happen, or it's acceptable for your application.
Testing
-------

Testing can be done using
`nose <https://nose.readthedocs.org/en/latest/>`__.

Release
-------

Need wheel package.
Testing can be done using `pytest <https://docs.pytest.org>`__.

.. 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
------------
Expand Down

0 comments on commit b09d6c9

Please sign in to comment.