Skip to content

Commit b09d6c9

Browse files
committed
update readme
Signed-off-by: Inada Naoki <songofacandy@gmail.com>
1 parent d248db5 commit b09d6c9

File tree

1 file changed

+14
-22
lines changed

1 file changed

+14
-22
lines changed

README.rst

+14-22
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
1-
A Python structured logger for Fluentd
2-
======================================
3-
4-
.. image:: https://travis-ci.org/fluent/fluent-logger-python.svg?branch=master
5-
:target: https://travis-ci.org/fluent/fluent-logger-python
6-
:alt: Build Status
7-
8-
.. image:: https://coveralls.io/repos/fluent/fluent-logger-python/badge.svg
9-
:target: https://coveralls.io/r/fluent/fluent-logger-python
10-
:alt: Coverage Status
1+
A Python structured logger for Fluentd/Fluent Bit
2+
=================================================
113

124
Many web/mobile applications generate huge amount of event logs (c,f.
135
login, logout, purchase, follow, etc). To analyze these event logs could
146
be really valuable for improving the service. However, the challenge is
157
collecting these logs easily and reliably.
168

17-
`Fluentd <https://github.com/fluent/fluentd>`__ solves that problem by
9+
`Fluentd <https://github.com/fluent/fluentd>`__ and `Fluent Bit <https://fluentbit.io/>`__ solves that problem by
1810
having: easy installation, small footprint, plugins, reliable buffering,
1911
log forwarding, etc.
2012

@@ -24,10 +16,11 @@ Python application.
2416
Requirements
2517
------------
2618

27-
- Python 3.5+
19+
- Python 3.7+
2820
- ``msgpack``
2921
- **IMPORTANT**: Version 0.8.0 is the last version supporting Python 2.6, 3.2 and 3.3
3022
- **IMPORTANT**: Version 0.9.6 is the last version supporting Python 2.7 and 3.4
23+
- **IMPORTANT**: Version 0.10.0 is the last version supporting Python 3.5 and 3.6
3124

3225
Installation
3326
------------
@@ -366,23 +359,22 @@ that this doesn't happen, or it's acceptable for your application.
366359
Testing
367360
-------
368361

369-
Testing can be done using
370-
`nose <https://nose.readthedocs.org/en/latest/>`__.
371-
372-
Release
373-
-------
374-
375-
Need wheel package.
362+
Testing can be done using `pytest <https://docs.pytest.org>`__.
376363

377364
.. code:: sh
378365
379-
$ pip install wheel
366+
$ pytest tests
380367
381-
After that, type following command:
368+
369+
Release
370+
-------
382371

383372
.. code:: sh
384373
385-
$ python setup.py clean sdist bdist_wheel upload
374+
$ # Download dist.zip for release from GitHub Action artifact.
375+
$ unzip -d dist dist.zip
376+
$ pipx twine upload dist/*
377+
386378
387379
Contributors
388380
------------

0 commit comments

Comments
 (0)