Skip to content

Commit b92744d

Browse files
committed
Add development instructions
1 parent 318c515 commit b92744d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,18 @@ If you wish to see more logs, simply set the `LOG_LEVEL` to the desired level. H
3434
| WARNING | Exceptional occurrences that are not errors. Undesirable things that are not necessarily wrong. | Use of deprecated APIs, poor use of an API, unauthorized access, pod restart because of memory limit ... |
3535
| ERROR | Runtime errors. Highlight when the current flow of execution is stopped due to a failure. | Exceptions messages, incorect credentials or permissions... |
3636
| CRITICAL | Critical conditions. Describe an unrecoverable application, system crash, or a catastrophic failure that requires immediate attention. | Application component unavailable, unexpected exception. entire website down, database unavailable ... |
37+
38+
## Development
39+
40+
For local development, create a new virtual environment and activate it. That can be done with Python `venv` module.
41+
42+
```bash
43+
$ python -m venv venv
44+
$ source venv/bin/activate
45+
```
46+
47+
Once the virtual environment is activated, install `python-bufflog` locally:
48+
49+
```bash
50+
$ pip install -e .
51+
```

0 commit comments

Comments
 (0)