{
    "info": {
        "author": "J\u00fcrgen Knauth",
        "author_email": "pubsrc@binary-overflow.de",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Framework :: Trio",
            "License :: OSI Approved :: Apache Software License",
            "Topic :: Software Development :: Testing",
            "Topic :: System :: Logging"
        ],
        "description": "jk_triologging\n==========\n\nIntroduction\n------------\n\nThis python module ...\n\nInformation about this module can be found here:\n\n* [github.org](https://github.com/jkpubsrc/....)\n* [pypi.python.org](https://pypi.python.org/pypi/jk_triologging)\n\nWhy this module?\n----------------\n\nWith `jk_logging` there is a logging module available that allows constructing loggers from a JSON based description, offers buffers for log messages and supports hierarchical logging. Unfortunately this particular module is synchroneous and therefore can not be used in `Trio` directly. This implementation therefore wraps `jk_logging` and provides an API usable in `Trio`.\n\nLimitations of this module\n--------------------------\n\nThis module provides classes wrapping (almost all) classes from `jk_logging`. It provides almost all functionality despite one: Descending hierarchically is not supported. (This might change one day, but not in the near future.)\n\nHow to install module\n----------------------\n\nThis module can be installed easily using `pip`.\n\nUse this command for a system wide installation of this module:\n\n```bash\n$ sudo pip install jk-triologging\n```\n\nUse this command for user specific installation of this module:\n\n```bash\n$ pip install --user jk-triologging\n```\n\nThe PiPy module is always kept in sync with the Github repository so using PyPi is equivalent to a manual installation using the code provided on Github.\n\nHow to use this module\n----------------------\n\n### Import this module\n\nPlease include this module into your application using the following code:\n\n```python\nimport jk_triologging\n```\n\n### Construct a logger\n\nExample:\n\n```python\nlog = jk_triologging.TrioConsoleLogger.create(logMsgFormatter=jk_triologging.COLOR_LOG_MESSAGE_FORMATTER)\n```\n\nHere we construct a console logger (which is an object that writes log messages to STDOUT.) It is configured for using colors for all output here.\n\n### Use the logger\n\nYou can create text based log messages and write them to the logger. Example:\n\n```python\nawait log.debug(\"This is a test for DEBUG.\")\nawait log.notice(\"This is a test for NOTICE.\")\nawait log.info(\"This is a test for INFO.\")\nawait log.warning(\"This is a test for WARNING.\")\nawait log.error(\"This is a test for ERROR.\")\n```\n\nExceptions can be logged as well. Example:\n\n```python\ntry:\n\tawait log.notice(\"Let's try a calculation that will fail ...\")\n\ta = 0\n\tb = 5 / a\nexcept Exception as ee:\n\tawait log.error(ee)\n```\n\nWhat kind of log objects are available?\n---------------------------------------\n\nYou can make use of the following log objects:\n\n* `TrioBufferLogger` - implements a buffer for log messages, which later on can be forwareded to another logger\n* `TrioConsoleLogger` - implements writing to STDOUT\n* `TrioFileLogger` - implements writing to a file\n* `TrioFilterLogger` - implements filtering of log messages according to log level\n* `TrioMulticastLogger` - implements forwarding log messages to multiple loggers\n* `TrioNamedMulticastLogger` - implements forwarding log messages to multiple loggers\n* `TrioNullLogger` - discards all log messages\n* `TrioStringListLogger` - implements a buffer for log messages, where all log messages are stored a plain text strings\n\nFurther Reading\n-------------------\n\nSee the `test` directory for detailed examples of all loggers.\n\nContact Information\n-------------------\n\nThis is Open Source code. That not only gives you the possibility of freely using this code it also\nallows you to contribute. Feel free to contact the author(s) of this software listed below, either\nfor comments, collaboration requests, suggestions for improvement or reporting bugs:\n\n* J\u00fcrgen Knauth: jknauth@uni-goettingen.de, pubsrc@binary-overflow.de\n\nLicense\n-------\n\nThis software is provided under the following license:\n\n* Apache Software License 2.0",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/jkpubsrc/python-module-jk-triologging/tarball/0.2019.10.19",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/jkpubsrc/python-module-jk-triologging",
        "keywords": "debugging,logging,trio",
        "license": "Apache 2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "jk-triologging",
        "package_url": "https://pypi.org/project/jk-triologging/",
        "platform": "",
        "project_url": "https://pypi.org/project/jk-triologging/",
        "project_urls": {
            "Download": "https://github.com/jkpubsrc/python-module-jk-triologging/tarball/0.2019.10.19",
            "Homepage": "https://github.com/jkpubsrc/python-module-jk-triologging"
        },
        "release_url": "https://pypi.org/project/jk-triologging/0.2019.10.19/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "This is a logging framework. It is based on jk_logging but can be used with Trio.",
        "version": "0.2019.10.19"
    },
    "last_serial": 5999443,
    "releases": {
        "0.2019.10.19": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8537c64ddaab407c092b4b85036617de",
                    "sha256": "7cf8ea518d4008a0d79df580ce9846e7129eb37d95af93baee749fc3878772e4"
                },
                "downloads": -1,
                "filename": "jk_triologging-0.2019.10.19.tar.gz",
                "has_sig": false,
                "md5_digest": "8537c64ddaab407c092b4b85036617de",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9642,
                "upload_time": "2019-10-19T10:31:37",
                "url": "https://files.pythonhosted.org/packages/be/14/79dddfc3d97044334210426940a9cc07887946f0a990f1c1605773baceea/jk_triologging-0.2019.10.19.tar.gz"
            }
        ],
        "0.2019.10.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "590f4e6d3ca3b17eb2f8f17469048c57",
                    "sha256": "b6f0d135769d1ba12ddc96ac9306ffb5002186863e7a931311f7d8ed1af35c3c"
                },
                "downloads": -1,
                "filename": "jk_triologging-0.2019.10.4.tar.gz",
                "has_sig": false,
                "md5_digest": "590f4e6d3ca3b17eb2f8f17469048c57",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8481,
                "upload_time": "2019-10-04T10:04:56",
                "url": "https://files.pythonhosted.org/packages/0d/b9/a371a58b4b3a8b06d8048ccbe289fe8fabd47eff6c954bd8c60378d04b2b/jk_triologging-0.2019.10.4.tar.gz"
            }
        ],
        "0.2019.10.4.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f65d44171dc3d5f526c990076d387731",
                    "sha256": "3f0155eee52dbb7a71843dd32fa920419071136f2cf9437c84f5051eb5aa07de"
                },
                "downloads": -1,
                "filename": "jk_triologging-0.2019.10.4.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f65d44171dc3d5f526c990076d387731",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9433,
                "upload_time": "2019-10-04T10:19:23",
                "url": "https://files.pythonhosted.org/packages/8d/37/7e18e85d2d440b44a68d4596bd1f576da5b51759875722deeecbab9816bf/jk_triologging-0.2019.10.4.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8537c64ddaab407c092b4b85036617de",
                "sha256": "7cf8ea518d4008a0d79df580ce9846e7129eb37d95af93baee749fc3878772e4"
            },
            "downloads": -1,
            "filename": "jk_triologging-0.2019.10.19.tar.gz",
            "has_sig": false,
            "md5_digest": "8537c64ddaab407c092b4b85036617de",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9642,
            "upload_time": "2019-10-19T10:31:37",
            "url": "https://files.pythonhosted.org/packages/be/14/79dddfc3d97044334210426940a9cc07887946f0a990f1c1605773baceea/jk_triologging-0.2019.10.19.tar.gz"
        }
    ]
}