logus


Namelogus JSON
Version 0.0.1 PyPI version JSON
download
home_page
SummaryStatic typed structured logging
upload_time2024-01-28 02:37:32
maintainer
docs_urlNone
author
requires_python>=3.8
licenseThe MIT License (MIT) Copyright (c) 2024 dd84ai / https://github.com/darklab8/darklab_logus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords logging structured typing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Static typed structured logging

# Description

This project araised from the need to log backend applications, aws lambdas and other stuff in modern cloud ecosystem. Logging systems today are able easily parsing JSON format out of the box.
Static typing approach brings here consistent way to define key values to final msg, as well as easier following Domain Driven Design, where logs consistently describe what they log. Static typed logging brings easy refactoring to any present logs.

# Features

- Accepts static typed components as optional params
  - it will not accept `any` options
  - has shortcut WithFields, to make clone of the logger with default logging fields
- Easy to turn on/off parameters by environment variables
  - Ability to define different log levels for different created loggers
- Easier turning complex objects into structured logging
  - accepts maps and structs as its params. It will parse them on their own.
[See folder examples](./examples)

# Python specifics

In order to function with python well, recommendation to turn on
- [strict mypy](<https://careers.wolt.com/en/blog/tech/professional-grade-mypy-configuration>)
- or pyright in one of [its mods](<https://github.com/microsoft/pyright/blob/main/docs/configuration.md>)

# Alternative Versions

- [Version in golang](https://github.com/darklab8/logusgo)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "logus",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "logging,structured,typing",
    "author": "",
    "author_email": "dd84ai <dark.dreamflyer@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/53/ea/620484a1adc32aba378b2a47f4180d1678284738574a11e7345d27f39e02/logus-0.0.1.tar.gz",
    "platform": null,
    "description": "Static typed structured logging\n\n# Description\n\nThis project araised from the need to log backend applications, aws lambdas and other stuff in modern cloud ecosystem. Logging systems today are able easily parsing JSON format out of the box.\nStatic typing approach brings here consistent way to define key values to final msg, as well as easier following Domain Driven Design, where logs consistently describe what they log. Static typed logging brings easy refactoring to any present logs.\n\n# Features\n\n- Accepts static typed components as optional params\n  - it will not accept `any` options\n  - has shortcut WithFields, to make clone of the logger with default logging fields\n- Easy to turn on/off parameters by environment variables\n  - Ability to define different log levels for different created loggers\n- Easier turning complex objects into structured logging\n  - accepts maps and structs as its params. It will parse them on their own.\n[See folder examples](./examples)\n\n# Python specifics\n\nIn order to function with python well, recommendation to turn on\n- [strict mypy](<https://careers.wolt.com/en/blog/tech/professional-grade-mypy-configuration>)\n- or pyright in one of [its mods](<https://github.com/microsoft/pyright/blob/main/docs/configuration.md>)\n\n# Alternative Versions\n\n- [Version in golang](https://github.com/darklab8/logusgo)\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2024 dd84ai / https://github.com/darklab8/darklab_logus  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Static typed structured logging",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/darklab8/loguspy"
    },
    "split_keywords": [
        "logging",
        "structured",
        "typing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4948ca29834564662f1530636b596520ea48fe2ef4264c16225bcc391f644086",
                "md5": "77bd7a0ff927985a67751358325cff63",
                "sha256": "020f748cb10f6ce6fc5c86f432f1037fc9d2856cc4f9a1261fdb6115f4d54701"
            },
            "downloads": -1,
            "filename": "logus-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "77bd7a0ff927985a67751358325cff63",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6579,
            "upload_time": "2024-01-28T02:37:30",
            "upload_time_iso_8601": "2024-01-28T02:37:30.540213Z",
            "url": "https://files.pythonhosted.org/packages/49/48/ca29834564662f1530636b596520ea48fe2ef4264c16225bcc391f644086/logus-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "53ea620484a1adc32aba378b2a47f4180d1678284738574a11e7345d27f39e02",
                "md5": "a780651b83d8f4f18593cfc9d68243c8",
                "sha256": "66d5c8395f95bd2a9f2e0e447d990d497200800cdad38a9acc17638accf0b658"
            },
            "downloads": -1,
            "filename": "logus-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a780651b83d8f4f18593cfc9d68243c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5290,
            "upload_time": "2024-01-28T02:37:32",
            "upload_time_iso_8601": "2024-01-28T02:37:32.369330Z",
            "url": "https://files.pythonhosted.org/packages/53/ea/620484a1adc32aba378b2a47f4180d1678284738574a11e7345d27f39e02/logus-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-28 02:37:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "darklab8",
    "github_project": "loguspy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "logus"
}
        
Elapsed time: 0.17049s