Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Bentz committed May 7, 2024
1 parent 65e93d4 commit 0a74f3f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This project helps separate the database and report logging from [`python_db_log
There are two methods to install this package in your project,

- Using `pyproject.toml`:
- Add `"report_handler @ git+https://git@github.com:/ctsit/report_handler.git"` in the `dependencies` section of the file.
- Run `pip3 install .` to install in the virtual environment.
- Add `report-handler = { git = "https://github.com/ctsit/report_handler.git", rev = "master", tag = "1.2.0" }` in the `tool.poetry.dependencies` section of the file.
- Run `poetry install` to install in the virtual environment.
- Using `setup.py`:
- Add `"report_handler @ git+https://[email protected]:/ctsit/report_handler.git"` in the `install_requires` section of the file.
- Run `pip3 install .` to install in the virtual environment.
Expand Down Expand Up @@ -68,6 +68,7 @@ logger = logging.getLogger()
logger.addHandler(report_handler)
```

Note: By default the `ReportHandler` will only capture logs that provide the dictionary (defined below) in the `extra` keyword argument of logging calls. To capture all logs without providing the dictionary, set the `verbose` flag in the `ReportHandler` constructor to `True`, i.e., `report_handler = ReportHandler(verbose=True)`.
To log, call the following functions as required by the logging level:

```python
Expand Down

0 comments on commit 0a74f3f

Please sign in to comment.