https://github.com/suundumused/pretty-logger
A simple custom python logger for any project.
https://github.com/suundumused/pretty-logger
console console-app console-application console-color console-log consoleapp log logger logging logs print printer printing python python-script python3 terminal terminal-app terminal-based
Last synced: 12 months ago
JSON representation
A simple custom python logger for any project.
- Host: GitHub
- URL: https://github.com/suundumused/pretty-logger
- Owner: Suundumused
- License: cc0-1.0
- Created: 2024-02-04T03:42:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T02:15:33.000Z (almost 2 years ago)
- Last Synced: 2024-04-13T14:05:32.190Z (almost 2 years ago)
- Topics: console, console-app, console-application, console-color, console-log, consoleapp, log, logger, logging, logs, print, printer, printing, python, python-script, python3, terminal, terminal-app, terminal-based
- Language: Python
- Homepage:
- Size: 76.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pretty-logger
### A simple, custom print and file logger for any project.
---
### Requirements
**Minimum Version**: `python 3.6... ...`
---
### Usage
**Importing**
from custom_console.logger import type_terminal
---
**Instancing**
console = type_terminal('SOFTWARE NAME', 'Log Output Folder', speed=0.998, time_format="%Y-%m-%d %H:%M:%S", pointer_char='⚮')
`pointer_char:str='⚮'` Refers to the character that will be used as the animated console cursor.
- You can instantiate it at the beginning of the file after import and use it in any class/function.
---
**Starting Pointer**
console.pointer()
- It's the animated pointer that is shown in the console while your program is still running, it doesn't interfere with the code functioning.
- Your project must have somewhat latent code or have recursion to be displayed.
---
### Print
console.info('Process terminated by machine user.')
**Available colour options:**
- '`ok`': GREEN,
- '`info`': WHITE,
- '`warning`': YELLOW
- '`error`': RED
---
console.error('some error....', write_file_path = True)
console.info(f'single_line_{i}%', Flush = True)
- `write_file_path = True` It will write a new line to the log file with exactly the same information as the print except the colors.
- `Flush = True` It will print in just one line for every hit.
---
### Example
if __name__ == "__main__":
console = type_terminal('program', 'E:/PyProjs/New folder', speed=0.998)
console.pointer()
console.ok('Something to show...') #simple print, without writing to the log file and without being on one line.
time.sleep(1)
i = 0
while i <= 5:
console.info(f'Progress: {i}%', Flush = True) #print in just one line.
i+=1
time.sleep(0.33)
console.error('Any ERROR OCCURRED to LOG file...', write_file_path = True) #printing and writing to the log.
console.warning('Any WARNING... OCCURRED to log file...')
console.pointer()
time.sleep(3)
#anything else...
---
### Log File result
| 2024-03-04 22:41:15 | :: | ERROR | :: | Any ERROR OCCURRED to LOG file...
| 2024-03-04 22:41:45 | :: | ERROR | :: | Any ERROR OCCURRED to LOG file...
| 2024-03-04 22:41:55 | :: | ERROR | :: | Any ERROR OCCURRED to LOG file...
| 2024-03-04 22:43:17 | :: | ERROR | :: | Any ERROR OCCURRED to LOG file...
| 2024-03-04 22:43:26 | :: | ERROR | :: | Any ERROR OCCURRED to LOG file...
---
## 💖 Support Me
If you find my work valuable and want to support me, consider making a donation. Your contribution goes a long way in helping me continue my open-source contributions and creating awesome content!
[](https://www.paypal.com/donate/?hosted_button_id=A2S5G97QM7XCJ)
[](https://www.paypal.com/donate/?hosted_button_id=A2S5G97QM7XCJ)
#### Bitcoin :: **bc1qa0xzyhcmcsuvppttmylzygwwfaken5jturhgek**
#### Ethereum :: **0x2fA70716D1Ae2f4994Be8e249b609056D72Ce80a**
---