Skip to main content

A simple Logging tool can extract as Markdown, PDF, or print console.

Project description

LLLLLLLLLLL                                                                                            SSSSSSSSSSSSSSS
L:::::::::L                                                                                          SS:::::::::::::::S
L:::::::::L                                                                                         S:::::SSSSSS::::::S
LL:::::::LL                                                                                         S:::::S     SSSSSSS
  L:::::L                  ooooooooooo      ggggggggg   ggggg   ggggggggg   ggggg    eeeeeeeeeeee   S:::::S
  L:::::L                oo:::::::::::oo   g:::::::::ggg::::g  g:::::::::ggg::::g  ee::::::::::::ee S:::::S
  L:::::L               o:::::::::::::::o g:::::::::::::::::g g:::::::::::::::::g e::::::eeeee:::::eeS::::SSSS
  L:::::L               o:::::ooooo:::::og::::::ggggg::::::ggg::::::ggggg::::::gge::::::e     e:::::e SS::::::SSSSS
  L:::::L               o::::o     o::::og:::::g     g:::::g g:::::g     g:::::g e:::::::eeeee::::::e   SSS::::::::SS
  L:::::L               o::::o     o::::og:::::g     g:::::g g:::::g     g:::::g e:::::::::::::::::e       SSSSSS::::S
  L:::::L               o::::o     o::::og:::::g     g:::::g g:::::g     g:::::g e::::::eeeeeeeeeee             S:::::S
  L:::::L         LLLLLLo::::o     o::::og::::::g    g:::::g g::::::g    g:::::g e:::::::e                      S:::::S
LL:::::::LLLLLLLLL:::::Lo:::::ooooo:::::og:::::::ggggg:::::g g:::::::ggggg:::::g e::::::::e         SSSSSSS     S:::::S
L::::::::::::::::::::::Lo:::::::::::::::o g::::::::::::::::g  g::::::::::::::::g  e::::::::eeeeeeee S::::::SSSSSS:::::S
L::::::::::::::::::::::L oo:::::::::::oo   gg::::::::::::::g   gg::::::::::::::g   ee:::::::::::::e S:::::::::::::::SS
LLLLLLLLLLLLLLLLLLLLLLLL   ooooooooooo       gggggggg::::::g     gggggggg::::::g     eeeeeeeeeeeeee  SSSSSSSSSSSSSSS
                                                     g:::::g             g:::::g
                                         gggggg      g:::::g gggggg      g:::::g
                                         g:::::gg   gg:::::g g:::::gg   gg:::::g
                                          g::::::ggg:::::::g  g::::::ggg:::::::g
                                           gg:::::::::::::g    gg:::::::::::::g
                                             ggg::::::ggg        ggg::::::ggg
                                                gggggg              gggggg

PyPI - Downloads Scrutinizer code quality (GitHub/Bitbucket) GitHub code size in bytes Scrutinizer coverage (GitHub/BitBucket) GitHub GitHub forks GitHub Repo stars PyPI

About :speaker:

If you want a different approach than following your logs by typing print between codes or do not want to use logging library, here is Logges.

With Logges, you can follow your logs that you want to follow, whether you print them on the screen or not, and automate your log outputs by making these log outputs as LOG, PDF, MD or Zipped file.

Installation :open_file_folder:

You can install Logges with typing pip install Logges on Python package managers/terminal. (Docker file will be here as soon as possible)

Usage :memo:

Library :closed_book:

console image

  • :pushpin: Import package as from Logges import Logges
  • :pushpin: Firstly, Optional parameter is Logges.setup(). You can name your log file with logname parameter and print logs with status parameters (Default is Logges.LogStatus.ERROR).
  • :pushpin: We have 5 log type under LogStatus enums;
    • :gem: LogStatus.DEBUG
    • :gem: LogStatus.INFO
    • :gem: LogStatus.WARNING
    • :gem: LogStatus.ERROR
    • :gem: LogStatus.CRITICAL
  • :pushpin: Before add logs, you can ignore specific files and directories on your logs with using ignore_files() method.
  • :pushpin: You can check in entered logs messages with in_log() method with keyword parameter. It returns True or False if keywords in log messages.
  • :pushpin: Finally, you can add your logs with log() method with specific parameters.
    • :heavy_plus_sign: msg parameter defines your messages, alsa could be a variable which can be print.
    • :heavy_plus_sign: status parameter defines your log type. Default is DEBUG but you can change it with LogStatus enums.
    • :heavy_plus_sign: print_log default is False, if your status is equal or upper than status of setup parameter, it will also print if you set it False.
  • :pushpin: Also you can export your logs as log, md, pdf or zip files, which is exported as md, pdf, log.

Check our example scripts to understand how to use.

CLI :clipboard:

console image

  • :pushpin: Also we have an CLI tool about log files.
  • :pushpin: logges is main command for listing, showing, searching operations.
  • :pushpin: logges list has 2 optional parameter for listing log files.
    • :gem: --max-date is filtering logs with maximum date.
    • :gem: --min-date is filtering logs with minimum date.
    • :gem: Please enter your date format as YYYY-MM-DD
  • :pushpin: logges show is showing entered filename.
    • :gem: -f/--file parameter is defines the log filename which is showing on list command or local file.
    • :gem: --local_file parameter default is False, if you want to see your local log file, you need to set this parameter True.
  • :pushpin: logges search is filtering command in all log files.
    • :gem: --max-date is filtering logs with maximum date.
    • :gem: --min-date is filtering logs with minimum date.
    • :gem: -sen/--sentences is REQUIRED parameter for filtering. It search keywords (seperated with ,) in log messages.
    • :gem: -fun/--functions is filtering functions on logs.
    • :gem: -sta/--status is filtering status on log.
    • :gem: -fi/--files is filtering executed files in log file.
    • :gem: -e/--export if you want to export result, set this parameter True.
    • :gem: --export_name, if you set --export=True, it defines exported file name.

Encountered Bugs :ghost:

If you find any bug or want to a feature nice-to-have, do not hesitate open an issue page.

Contact :tophat:

Serkan UYSAL - Özkan UYSAL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logges-2.3.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

logges-2.3-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file logges-2.3.tar.gz.

File metadata

  • Download URL: logges-2.3.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.5 Darwin/23.5.0

File hashes

Hashes for logges-2.3.tar.gz
Algorithm Hash digest
SHA256 0b33e3b2bc8ee6afeeab85e34d70a13a01de6a9293b8491ba2e8b7ded3826601
MD5 6f4104543410f8e037562144835749e2
BLAKE2b-256 1a6688a665a7e7eb0238135e37a963bf258708a1a626e550950412213f33ccfb

See more details on using hashes here.

File details

Details for the file logges-2.3-py3-none-any.whl.

File metadata

  • Download URL: logges-2.3-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.5 Darwin/23.5.0

File hashes

Hashes for logges-2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 96f2ec66dd2b946b35b191bf53a90e663fee9aa185c00e4d2e95ee566d491863
MD5 23c1e6ed1063ca2faab4f12c49197e74
BLAKE2b-256 aa6ec44fa1e24cf4a028f6a88edb0dc59503abccd2c9a1cb73f99d4d78a23169

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page