Skip to content

Commit 934b56f

Browse files
committed
Update README for 3.0.0 release
1 parent 7c5a3e6 commit 934b56f

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,35 @@ This repository is a maintained fork of [madzak/python-json-logger](https://gith
1313

1414
## Installation
1515

16-
### Install via pip / PyPI
16+
Note: All versions of this fork use version `>=3.0.0` - to use pre-fork versions use `python-json-logger<3.0.0`.
1717

18-
Until the PEP 541 request is complete you will need to use one of the alternative methods below.
18+
### Install via pip
1919

20-
### Install from GitHub
20+
Until the PEP 541 request is complete you will need to install directly from github.
21+
22+
#### Install from GitHub
23+
24+
To install from releases:
25+
26+
```shell
27+
# 3.0.0 wheel
28+
pip install 'python-json-logger@https://github.com/nhairs/python-json-logger/releases/download/v3.0.0/python_json_logger-3.0.0-py3-none-any.whl'
29+
```
30+
31+
To install from head:
2132

2233
```shell
2334
pip install 'python-json-logger@git+https://github.com/nhairs/python-json-logger.git'
2435
```
2536

26-
To install a specific version:
37+
To install a specific version from a tag:
2738

2839
```shell
40+
# Last released version before forking
2941
pip install 'python-json-logger@git+https://github.com/nhairs/python-json-logger.git@v2.0.7'
3042
```
3143

32-
33-
### Install from Source
44+
#### Install from Source
3445

3546
```shell
3647
git clone https://github.com/nhairs/python-json-logger.git
@@ -44,8 +55,6 @@ pip install -e .
4455

4556
Json outputs are provided by the JsonFormatter logging formatter. You can add the custom formatter like below:
4657

47-
**Please note: version 0.1.0 has changed the import structure, please update to the following example for proper importing**
48-
4958
```python
5059
import logging
5160
from pythonjsonlogger import jsonlogger

0 commit comments

Comments
 (0)