Logges


NameLogges JSON
Version 2.3 PyPI version JSON
download
home_pagehttps://github.com/uysalserkan/Logges
SummaryA simple Logging tool can extract as Markdown, PDF, or print console.
upload_time2024-10-30 07:59:16
maintainerSerkan UYSAL
docs_urlNone
authorSerkan UYSAL
requires_python<4.0,>=3.10
licenseMIT
keywords log logging logges logger logging markdown pdf console
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ```txt
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](https://img.shields.io/pypi/dm/logges?label=Downloads&logo=monthly_download&style=flat-square) ![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/b/uysalserkan/logges/main?style=flat-square) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/uysalserkan/logges?style=flat-square) ![Scrutinizer coverage (GitHub/BitBucket)](https://img.shields.io/scrutinizer/coverage/b/uysalserkan/logges/main?style=flat-square) ![GitHub](https://img.shields.io/github/license/uysalserkan/logges?style=flat-square) ![GitHub forks](https://img.shields.io/github/forks/uysalserkan/logges?style=social) ![GitHub Repo stars](https://img.shields.io/github/stars/uysalserkan/logges?style=social) ![PyPI](https://img.shields.io/pypi/v/logges?style=flat-square)

- [About :speaker:](#about-speaker)
- [Installation :open_file_folder:](#installation-open_file_folder)
- [Usage :memo:](#usage-memo)
  - [Library :closed_book:](#library-closed_book)
  - [CLI :clipboard:](#cli-clipboard)
- [Encountered Bugs :ghost:](#encountered-bugs-ghost)
- [Contact :tophat:](#contact-tophat)

## 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 **Zip**ped 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](/imgs/img_2.png)

- :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](examples) scripts to understand how to use.

### CLI :clipboard:

![console image](/imgs/img_1.png)

- :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**](https://github.com/uysalserkan/Logges/issues/new).

## Contact :tophat:

[Serkan UYSAL](https://github.com/uysalserkan) - [Özkan UYSAL](https://github.com/ozkanuysal)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/uysalserkan/Logges",
    "name": "Logges",
    "maintainer": "Serkan UYSAL",
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": "uysalserkan08@gmail.com",
    "keywords": "Log, Logging, Logges, Logger, logging, markdown, pdf, console",
    "author": "Serkan UYSAL",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/1a/66/88a665a7e7eb0238135e37a963bf258708a1a626e550950412213f33ccfb/logges-2.3.tar.gz",
    "platform": null,
    "description": "```txt\nLLLLLLLLLLL                                                                                            SSSSSSSSSSSSSSS\nL:::::::::L                                                                                          SS:::::::::::::::S\nL:::::::::L                                                                                         S:::::SSSSSS::::::S\nLL:::::::LL                                                                                         S:::::S     SSSSSSS\n  L:::::L                  ooooooooooo      ggggggggg   ggggg   ggggggggg   ggggg    eeeeeeeeeeee   S:::::S\n  L:::::L                oo:::::::::::oo   g:::::::::ggg::::g  g:::::::::ggg::::g  ee::::::::::::ee S:::::S\n  L:::::L               o:::::::::::::::o g:::::::::::::::::g g:::::::::::::::::g e::::::eeeee:::::eeS::::SSSS\n  L:::::L               o:::::ooooo:::::og::::::ggggg::::::ggg::::::ggggg::::::gge::::::e     e:::::e SS::::::SSSSS\n  L:::::L               o::::o     o::::og:::::g     g:::::g g:::::g     g:::::g e:::::::eeeee::::::e   SSS::::::::SS\n  L:::::L               o::::o     o::::og:::::g     g:::::g g:::::g     g:::::g e:::::::::::::::::e       SSSSSS::::S\n  L:::::L               o::::o     o::::og:::::g     g:::::g g:::::g     g:::::g e::::::eeeeeeeeeee             S:::::S\n  L:::::L         LLLLLLo::::o     o::::og::::::g    g:::::g g::::::g    g:::::g e:::::::e                      S:::::S\nLL:::::::LLLLLLLLL:::::Lo:::::ooooo:::::og:::::::ggggg:::::g g:::::::ggggg:::::g e::::::::e         SSSSSSS     S:::::S\nL::::::::::::::::::::::Lo:::::::::::::::o g::::::::::::::::g  g::::::::::::::::g  e::::::::eeeeeeee S::::::SSSSSS:::::S\nL::::::::::::::::::::::L oo:::::::::::oo   gg::::::::::::::g   gg::::::::::::::g   ee:::::::::::::e S:::::::::::::::SS\nLLLLLLLLLLLLLLLLLLLLLLLL   ooooooooooo       gggggggg::::::g     gggggggg::::::g     eeeeeeeeeeeeee  SSSSSSSSSSSSSSS\n                                                     g:::::g             g:::::g\n                                         gggggg      g:::::g gggggg      g:::::g\n                                         g:::::gg   gg:::::g g:::::gg   gg:::::g\n                                          g::::::ggg:::::::g  g::::::ggg:::::::g\n                                           gg:::::::::::::g    gg:::::::::::::g\n                                             ggg::::::ggg        ggg::::::ggg\n                                                gggggg              gggggg\n\n```\n\n![PyPI - Downloads](https://img.shields.io/pypi/dm/logges?label=Downloads&logo=monthly_download&style=flat-square) ![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/b/uysalserkan/logges/main?style=flat-square) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/uysalserkan/logges?style=flat-square) ![Scrutinizer coverage (GitHub/BitBucket)](https://img.shields.io/scrutinizer/coverage/b/uysalserkan/logges/main?style=flat-square) ![GitHub](https://img.shields.io/github/license/uysalserkan/logges?style=flat-square) ![GitHub forks](https://img.shields.io/github/forks/uysalserkan/logges?style=social) ![GitHub Repo stars](https://img.shields.io/github/stars/uysalserkan/logges?style=social) ![PyPI](https://img.shields.io/pypi/v/logges?style=flat-square)\n\n- [About :speaker:](#about-speaker)\n- [Installation :open_file_folder:](#installation-open_file_folder)\n- [Usage :memo:](#usage-memo)\n  - [Library :closed_book:](#library-closed_book)\n  - [CLI :clipboard:](#cli-clipboard)\n- [Encountered Bugs :ghost:](#encountered-bugs-ghost)\n- [Contact :tophat:](#contact-tophat)\n\n## About :speaker:\n\nIf 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**.\n\nWith **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 **Zip**ped file.\n\n## Installation :open_file_folder:\n\nYou can install Logges with typing `pip install Logges` on Python package managers/terminal. (_Docker file will be here as soon as possible_)\n\n## Usage :memo:\n\n### Library :closed_book:\n\n![console image](/imgs/img_2.png)\n\n- :pushpin: Import package as `from Logges import Logges`\n- :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`).\n- :pushpin: We have 5 log type under LogStatus enums;\n  - :gem: LogStatus.DEBUG\n  - :gem: LogStatus.INFO\n  - :gem: LogStatus.WARNING\n  - :gem: LogStatus.ERROR\n  - :gem: LogStatus.CRITICAL\n- :pushpin: Before add logs, you can ignore specific files and directories on your logs with using `ignore_files()` method.\n- :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.\n- :pushpin: Finally, you can add your logs with `log()` method with specific parameters.\n  - :heavy_plus_sign: `msg` parameter defines your messages, alsa could be a variable which can be print.\n  - :heavy_plus_sign: `status` parameter defines your log type. Default is **DEBUG** but you can change it with LogStatus enums.\n  - :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`.\n- :pushpin: Also you can export your logs as `log`, `md`, `pdf` or `zip` files, which is exported as `md, pdf, log`.\n\nCheck our [example](examples) scripts to understand how to use.\n\n### CLI :clipboard:\n\n![console image](/imgs/img_1.png)\n\n- :pushpin: Also we have an CLI tool about log files.\n- :pushpin: `logges` is main command for listing, showing, searching operations.\n- :pushpin: `logges list` has 2 optional parameter for listing log files.\n  - :gem: `--max-date` is filtering logs with maximum date.\n  - :gem: `--min-date` is filtering logs with minimum date.\n  - :gem: Please enter your date format as _YYYY-MM-DD_\n- :pushpin: `logges show` is showing entered filename.\n  - :gem: `-f`/`--file` parameter is defines the log filename which is showing on `list` command or local file.\n  - :gem: `--local_file` parameter default is `False`, if you want to see your local log file, you need to set this parameter `True`.\n- :pushpin: `logges search` is filtering command in all log files.\n  - :gem: `--max-date` is filtering logs with maximum date.\n  - :gem: `--min-date` is filtering logs with minimum date.\n  - :gem: `-sen`/`--sentences` is REQUIRED parameter for filtering. It search keywords (seperated with `,`) in log messages.\n  - :gem: `-fun`/`--functions` is filtering functions on logs.\n  - :gem: `-sta`/`--status` is filtering status on log.\n  - :gem: `-fi`/`--files` is filtering executed files in log file.\n  - :gem: `-e`/`--export` if you want to export result, set this parameter `True`.\n  - :gem: `--export_name`, if you set `--export=True`, it defines exported file name.\n\n## Encountered Bugs :ghost:\n\nIf you find any bug or want to a feature nice-to-have, do not hesitate open an [**issue page**](https://github.com/uysalserkan/Logges/issues/new).\n\n## Contact :tophat:\n\n[Serkan UYSAL](https://github.com/uysalserkan) - [\u00d6zkan UYSAL](https://github.com/ozkanuysal)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple Logging tool can extract as Markdown, PDF, or print console.",
    "version": "2.3",
    "project_urls": {
        "Homepage": "https://github.com/uysalserkan/Logges",
        "Repository": "https://github.com/uysalserkan/Logges"
    },
    "split_keywords": [
        "log",
        " logging",
        " logges",
        " logger",
        " logging",
        " markdown",
        " pdf",
        " console"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aa6ec44fa1e24cf4a028f6a88edb0dc59503abccd2c9a1cb73f99d4d78a23169",
                "md5": "23c1e6ed1063ca2faab4f12c49197e74",
                "sha256": "96f2ec66dd2b946b35b191bf53a90e663fee9aa185c00e4d2e95ee566d491863"
            },
            "downloads": -1,
            "filename": "logges-2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "23c1e6ed1063ca2faab4f12c49197e74",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 14420,
            "upload_time": "2024-10-30T07:59:15",
            "upload_time_iso_8601": "2024-10-30T07:59:15.061444Z",
            "url": "https://files.pythonhosted.org/packages/aa/6e/c44fa1e24cf4a028f6a88edb0dc59503abccd2c9a1cb73f99d4d78a23169/logges-2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a6688a665a7e7eb0238135e37a963bf258708a1a626e550950412213f33ccfb",
                "md5": "6f4104543410f8e037562144835749e2",
                "sha256": "0b33e3b2bc8ee6afeeab85e34d70a13a01de6a9293b8491ba2e8b7ded3826601"
            },
            "downloads": -1,
            "filename": "logges-2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "6f4104543410f8e037562144835749e2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 14531,
            "upload_time": "2024-10-30T07:59:16",
            "upload_time_iso_8601": "2024-10-30T07:59:16.593125Z",
            "url": "https://files.pythonhosted.org/packages/1a/66/88a665a7e7eb0238135e37a963bf258708a1a626e550950412213f33ccfb/logges-2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-30 07:59:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "uysalserkan",
    "github_project": "Logges",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "logges"
}
        
Elapsed time: 0.41204s