https://github.com/selva221724/dummylog
logging made easy for python module/plugin developers
https://github.com/selva221724/dummylog
django flask log logging pip python thread
Last synced: about 2 months ago
JSON representation
logging made easy for python module/plugin developers
- Host: GitHub
- URL: https://github.com/selva221724/dummylog
- Owner: selva221724
- License: mit
- Created: 2021-11-22T11:46:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-24T10:11:24.000Z (over 4 years ago)
- Last Synced: 2025-06-05T01:17:48.380Z (about 1 year ago)
- Topics: django, flask, log, logging, pip, python, thread
- Language: Python
- Homepage:
- Size: 70.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[
](https://pypi.org/project/dummylog/)
[
](https://opensource.org/licenses/MIT)
`dummylog` is the open source python package to help the python module/plugin developers to create/update the log files in simple syntax and easy format. If you are looking for a single file based log, then dummylog is for you to keep your simple logs
If you are using `Flask API` or any API decorators with `dummylog`, it will create a new log every time since decorators will trigger the function as every new instance.
## Installation
**Install using pip** . [Offical Python Package Here!!](https://pypi.org/project/dummylog/)
```shell
pip install dummylog
```
(OR)
Clone this Repository. Run this from the root directory to install
```shell
python setup.py install
```
## License
The license for dummylog is MIT license
## Need help?
Stuck on your dummylog code or problem? Any other questions? Don't
hestitate to send me an email (selva221724@gmail.com).
## Usage
### 1. Import Package
```python
import dummylog
```
### 2. Initialize the dummylog Object
```python
dl = dummylog.DummyLog()
```
#### `dummylog.DummyLog()` parameters
|S.No |Parameters | Description | Type | Default Value |
| -------------| ------------- | ------------- | ------------- | ------------- |
|1 | log_name | Name of the log instance/file | string | "temp" |
|2 | logging_level | [level of logging that user needed](https://docs.python.org/3/library/logging.html#levels) | string | "debug" |
|3 | string_format | [Formatter for logging](https://docs.python.org/3/library/logging.html#formatter-objects) | string | "%(asctime)s: %(levelname)s: %(message)s" |
|3 | datetime_format | Date-time format for logging | string | "%m/%d/%Y %I:%M:%S %p" |
|4 | log_on_folder | True if you want to save them in a folder | bool | True |
|5 | log_folder_name | Name of the folder to save the logs | string | "logs" |
### 3. Enjoy Logging
```python
dl.logger.info('Log File is Created Successfully')
dl.logger.info('Unmayanaa Google Competitors')
dl.logger.error('Vada poche')
```
This will create a log file in the root directory of the python script.
### 4. To Kill the dummylog instance
```python
dl.kill()
```
**Note:** Do not use `dummylog` in case if you are using the logging module in the same script for other purposes. it may conflict with the logging thread and append things to gather.
### 5. To Create Multiple Logs
```python
dl_1 = dummylog.DummyLog(log_name = 'one')
dl_1.logger.info('Log File is Created Successfully')
dl_1.logger.info('Unmayanaa Google Competitors')
dl_1.logger.error('Vada poche')
dl_2 = dummylog.DummyLog(log_name = 'two')
dl_2.logger.info('Log File is Created Successfully')
dl_2.logger.info('Unmayanaa Google Competitors')
dl_2.logger.error('Vada poche')
```
It will create two `.log` files:
```
logs
├── one.log
└── two.log
```
### Sample Log File View
