{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": ".. -*- mode: rst -*-\n\npyfortified-logging\n-------------------\n\nThis Python project is an extension of the native Python component `logging `_\nproviding more robust message formatting for standard and JSON logging output, and in addtion allowing for extra\ncontent populated as dictionaries.\n\npypi.org\n^^^^^^^^\n\nhttps://pypi.org/project/pyfortified-logging/\n\n\nWork In Progress\n^^^^^^^^^^^^^^^^\n\nThe following still needs to be performed for this Python project:\n\n- Unit-testing: This project will be switching over to using Python native Unit testing framework `unittest `_.\n- More concise documentation is required.\n- Travis CI\n- Badges\n\n\nBadges\n------\n\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install pyfortified_logging\n\n\nArchitecture\n------------\n\n\nFunction: get_logger()\n----------------------\n\n.. code-block:: python\n\n def get_logger(\n logger_name,\n logger_version=None,\n logger_level=logging.INFO,\n logger_format=LoggingFormat.JSON,\n logger_output=LoggingOutput.STDOUT_COLOR,\n logger_handler=None\n ):\n\n\nget_logger(): Parameters\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n+-----------------+-------------------------------------------------------------------------------------------------------------------------+\n| Parameter | Purpose |\n+=================+=========================================================================================================================+\n| logger_name | Return a logger with the specified name or, if name is None, return a logger which is the root logger of the hierarchy. |\n+-----------------+-------------------------------------------------------------------------------------------------------------------------+\n| logger_version | |\n+-----------------+-------------------------------------------------------------------------------------------------------------------------+\n| logger_format | LoggingFormat |\n+-----------------+-------------------------------------------------------------------------------------------------------------------------+\n| logger_output | LoggingOutput |\n+-----------------+-------------------------------------------------------------------------------------------------------------------------+\n| logger_handler | logging.StreamHandler() or logging.FileHandler() |\n+-----------------+-------------------------------------------------------------------------------------------------------------------------+\n\n\n\nLogging Levels\n^^^^^^^^^^^^^^\n\nSame Python logging levels, including one additional level NOTE.\n\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n| Level | Purpose |\n+============+================================================================================================================================================+\n| DEBUG | Detailed information, typically of interest only when diagnosing problems. |\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n| NOTE | Detailed information, request processing, for example, request using cURL. |\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n| INFO | Confirmation that things are working as expected. *[DEFAULT]* |\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n| WARNING | An indication that something unexpected happened, or indicative of some problem in the near future. The software is still working as expected. |\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n| ERROR | Due to a more serious problem, the software has not been able to perform some function. |\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n| CRITICAL | A serious error, indicating that the program itself may be unable to continue running. |\n+------------+------------------------------------------------------------------------------------------------------------------------------------------------+\n\n\n\nLogging Format\n^^^^^^^^^^^^^^\n\n+------------+-------------------------------------------------------------------------------------------------------+\n| Format | Purpose |\n+============+=======================================================================================================+\n| STANDARD | Standard logging format. |\n+------------+-------------------------------------------------------------------------------------------------------+\n| JSON | JSON logging format. *[DEFAULT]* |\n+------------+-------------------------------------------------------------------------------------------------------+\n\n\n.. code-block:: python\n\n class LoggingFormat(object):\n \"\"\"TUNE Logging Format ENUM\n \"\"\"\n STANDARD = \"standard\"\n JSON = \"json\"\n\n\n\nLogging Output\n^^^^^^^^^^^^^^\n\n+--------------+----------------------------------------------------------------------------------------------+\n| Output | Purpose |\n+==============+==============================================================================================+\n| STDOUT | Standard Output to terminal |\n+--------------+----------------------------------------------------------------------------------------------+\n| STDOUT_COLOR | Standard Output using colored terminal |\n+--------------+----------------------------------------------------------------------------------------------+\n| FILE | Standard Output to file created within *./tmp/log_.json*. |\n+--------------+----------------------------------------------------------------------------------------------+\n\n\n.. code-block:: python\n\n class LoggingOutput(object):\n \"\"\"Logging Format ENUM\n \"\"\"\n STDOUT = \"stdout\"\n STDOUT_COLOR = \"color\"\n FILE = \"file\"\n\n\nLogging JSON Format\n^^^^^^^^^^^^^^^^^^^\n\n.. code-block:: python\n\n import logging\n from pyfortified_logging import (LoggingFormat, get_logger, __version__)\n\n log = get_logger(\n logger_name=__name__,\n logger_version=__version__,\n logger_format=LoggingFormat.JSON,\n logger_level=logging.NOTE\n )\n\n log.info(\"logging: info\", extra={'test': __name__})\n log.note(\"logging: note\", extra={'test': __name__})\n log.debug(\"logging: debug\", extra={'test': __name__})\n log.warning(\"logging: warning\", extra={'test': __name__})\n log.error(\"logging: error\", extra={'test': __name__})\n log.critical(\"logging: critical\", extra={'test': __name__})\n log.exception(\"logging: exception\", extra={'test': __name__})\n\n\nLogging JSON Example Output\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code-block:: bash\n\n $ python3 examples/example_logging_json.py\n\n {\"asctime\": \"2018-05-11 05:41:39 -0700\", \"levelname\": \"INFO\", \"name\": \"__main__\",\n \"version\": \"0.1.6\", \"message\": \"logging: info\", \"test\": \"__main__\"}\n {\"asctime\": \"2018-05-11 05:41:39 -0700\", \"levelname\": \"NOTE\", \"name\": \"__main__\",\n \"version\": \"0.1.6\", \"message\": \"logging: note\", \"test\": \"__main__\"}\n {\"asctime\": \"2018-05-11 05:41:39 -0700\", \"levelname\": \"WARNING\", \"name\": \"__main__\",\n \"version\": \"0.1.6\", \"message\": \"logging: warning\", \"test\": \"__main__\"}\n {\"asctime\": \"2018-05-11 05:41:39 -0700\", \"levelname\": \"ERROR\", \"name\": \"__main__\",\n \"version\": \"0.1.6\", \"message\": \"logging: error\", \"test\": \"__main__\"}\n {\"asctime\": \"2018-05-11 05:41:39 -0700\", \"levelname\": \"CRITICAL\", \"name\": \"__main__\",\n \"version\": \"0.1.6\", \"message\": \"logging: critical\", \"test\": \"__main__\"}\n {\"asctime\": \"2018-05-11 05:41:39 -0700\", \"levelname\": \"ERROR\", \"name\": \"__main__\",\n \"version\": \"0.1.6\", \"message\": \"logging: exception\", \"exc_info\": \"NoneType: None\",\n \"test\": \"__main__\"}\n\n\nRequirements\n------------\n\n``pyfortified-logging`` module is built upon Python 3 and has dependencies upon\nseveral Python modules available within `Python Package Index PyPI `_.\n\n.. code-block:: bash\n\n make install-requirements\n\nor\n\n\n.. code-block:: bash\n\n python3 -m pip uninstall --yes --no-input -r requirements.txt\n python3 -m pip install --upgrade -r requirements.txt\n\n\nDependencies\n^^^^^^^^^^^^\n\n- coloredlogs: https://pypi.python.org/pypi/coloredlogs\n- pprintpp: https://pypi.python.org/pypi/pprintpp\n- python-json-logger: https://pypi.python.org/pypi/python-json-logger\n- Pygments: https://pypi.python.org/pypi/Pygments\n- wheel: https://pypi.python.org/pypi/wheel\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/jeff00seattle/pyfortified-logging/archive/v0.2.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jeff00seattle/pyfortified-logging", "keywords": "pyfortified logging", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "pyfortified-logging", "package_url": "https://pypi.org/project/pyfortified-logging/", "platform": "", "project_url": "https://pypi.org/project/pyfortified-logging/", "project_urls": { "Download": "https://github.com/jeff00seattle/pyfortified-logging/archive/v0.2.1.tar.gz", "Homepage": "https://github.com/jeff00seattle/pyfortified-logging" }, "release_url": "https://pypi.org/project/pyfortified-logging/0.2.1/", "requires_dist": null, "requires_python": "", "summary": "Extension to Python `logging` functionality.", "version": "0.2.1" }, "last_serial": 4446728, "releases": { "0.1.6": [ { "comment_text": "", "digests": { "md5": "dbd7bdc5f1a61c8f03466f019e6aee85", "sha256": "039f39d4a0280341f1c57e4ff51cd9bfcb59e71b3e5a1a0a73b6dc01386ba08f" }, "downloads": -1, "filename": "pyfortified_logging-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "dbd7bdc5f1a61c8f03466f019e6aee85", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 13078, "upload_time": "2018-05-14T16:39:54", "url": "https://files.pythonhosted.org/packages/51/33/091ebd5b9276fc47f696b3f306805bb91cdb352a28aee2b158c72dd9b15d/pyfortified_logging-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86f7437ec203fd5127da9c64405153fc", "sha256": "841d4e7b58583f2cd1aac5c6965951544356f13dc0fdbbbffe574d91fda25766" }, "downloads": -1, "filename": "pyfortified-logging-0.1.6.tar.gz", "has_sig": false, "md5_digest": "86f7437ec203fd5127da9c64405153fc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32655, "upload_time": "2018-05-14T16:39:52", "url": "https://files.pythonhosted.org/packages/6f/06/c47a59d2e806a0a9bdd1373db0a415c0163d48e42e34cf1d4c8c40547977/pyfortified-logging-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "07345bfb4a7e03e6826c55cf585a2919", "sha256": "9c059f0d8ed1bcdadcc34accb2e9a23c9cdb59139b1733df581dcfbe08a0f417" }, "downloads": -1, "filename": "pyfortified_logging-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "07345bfb4a7e03e6826c55cf585a2919", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 12620, "upload_time": "2018-05-14T16:44:15", "url": "https://files.pythonhosted.org/packages/f0/77/38fc2e41b94133c85dbf8bc1c272f6c56dfa5c3d8627853fc53aa894d297/pyfortified_logging-0.1.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2cbe99520eb35d905508598adc5d05cf", "sha256": "f0105240c6cf9b18064dc9a2aedd437ad192da7fef94c40866c2bfd7db9a6cb3" }, "downloads": -1, "filename": "pyfortified-logging-0.1.7.tar.gz", "has_sig": false, "md5_digest": "2cbe99520eb35d905508598adc5d05cf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31574, "upload_time": "2018-05-14T16:44:13", "url": "https://files.pythonhosted.org/packages/f9/0f/7790fd11fe916d2c4193c7ae2bfd33f128c759ff9c252a415cf64fd25014/pyfortified-logging-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "a82aaa8c8e7d664b1bb3b003f7947d93", "sha256": "756c03bb873a3ce8dade0c47f923f55adf5888af0f2bc570fc6bd1a9812e4cf1" }, "downloads": -1, "filename": "pyfortified_logging-0.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "a82aaa8c8e7d664b1bb3b003f7947d93", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 12612, "upload_time": "2018-05-14T17:07:48", "url": "https://files.pythonhosted.org/packages/33/cc/89c8ccb5d9f505cba9560cc367b3b0077d5acb30fe5a598a602a0b53847f/pyfortified_logging-0.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "31f0866896c7a47a0ee1e1cf0578b14d", "sha256": "236ccff2d6b204b134fdb1a8cc14aa6c2318ca5f130239662278c10c60640def" }, "downloads": -1, "filename": "pyfortified-logging-0.1.8.tar.gz", "has_sig": false, "md5_digest": "31f0866896c7a47a0ee1e1cf0578b14d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31507, "upload_time": "2018-05-14T17:07:46", "url": "https://files.pythonhosted.org/packages/fb/1e/d42ad77d0ec88e1aa73fda122e5d1256aea483c72aa9d3d9ec4db9a91367/pyfortified-logging-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "ac387a4184cc1d2d9058b32856559e07", "sha256": "714e5cbd22f7d7361754ffaea0c4dafadca0ac59507b7159d7952c843bf5ebf6" }, "downloads": -1, "filename": "pyfortified_logging-0.1.9-py3-none-any.whl", "has_sig": false, "md5_digest": "ac387a4184cc1d2d9058b32856559e07", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 12612, "upload_time": "2018-05-14T17:33:48", "url": "https://files.pythonhosted.org/packages/43/28/90679c55c076882fe4cd3b56c8fd0e8b45b2f9ac9d0861d31ed84b4dc9e7/pyfortified_logging-0.1.9-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c466f5bfdbd9f708c0422d837fe3115d", "sha256": "12495c9009cc42a02610e01e5c550af4676fa2439a4799c980b135e677b8d762" }, "downloads": -1, "filename": "pyfortified-logging-0.1.9.tar.gz", "has_sig": false, "md5_digest": "c466f5bfdbd9f708c0422d837fe3115d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31495, "upload_time": "2018-05-14T17:33:46", "url": "https://files.pythonhosted.org/packages/fa/42/c9fc7fc665eb068397defc3e92c0c2a79e9a3f2ab168c97f71ab4f6fd7fc/pyfortified-logging-0.1.9.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "e5feaab06581604a9a11bb7f8857d5ad", "sha256": "bf9ae84c632a3d610c08d9594a36be56e906d78af0eb312e7a97294683ebcf9f" }, "downloads": -1, "filename": "pyfortified_logging-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e5feaab06581604a9a11bb7f8857d5ad", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 12537, "upload_time": "2018-11-03T04:39:43", "url": "https://files.pythonhosted.org/packages/e7/87/77feace07ead787e11893506b1c7591a6ce1551d8f9f1497d2bc76b25a4f/pyfortified_logging-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "96c4fac8b4d615ab8d3499622ad7057e", "sha256": "de191e0e495140ab54bf420bd36259e4798cf0a4571e7c900373fcd39251224d" }, "downloads": -1, "filename": "pyfortified-logging-0.2.0.tar.gz", "has_sig": false, "md5_digest": "96c4fac8b4d615ab8d3499622ad7057e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31407, "upload_time": "2018-11-03T04:39:41", "url": "https://files.pythonhosted.org/packages/c8/ff/212c96776f7620629c57a2240487b35996282f39bfb91530f23de4d52f5b/pyfortified-logging-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "d5b71ddf3a73e1d3dfeb0cfefd1a17f9", "sha256": "8acacafb289bcc53fd29f45167ac9a63f56b674e87711d3679ec928876778416" }, "downloads": -1, "filename": "pyfortified_logging-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d5b71ddf3a73e1d3dfeb0cfefd1a17f9", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 12490, "upload_time": "2018-11-03T04:43:40", "url": "https://files.pythonhosted.org/packages/77/a1/9ceb091ef182520590d75658a9f6e55879047f1eb6f29ef5bc69a7b00ec5/pyfortified_logging-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5dc3a0f82ff874fc91af758515fbe0bb", "sha256": "3399366edc29982311de270a8f020dd395b7f59a243cfe246b13ef67c96955ce" }, "downloads": -1, "filename": "pyfortified-logging-0.2.1.tar.gz", "has_sig": false, "md5_digest": "5dc3a0f82ff874fc91af758515fbe0bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31316, "upload_time": "2018-11-03T04:43:38", "url": "https://files.pythonhosted.org/packages/43/af/51b1347af203ee9f2eafd762472e7736274a3507c2f0141ae29dd33ef3a3/pyfortified-logging-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d5b71ddf3a73e1d3dfeb0cfefd1a17f9", "sha256": "8acacafb289bcc53fd29f45167ac9a63f56b674e87711d3679ec928876778416" }, "downloads": -1, "filename": "pyfortified_logging-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d5b71ddf3a73e1d3dfeb0cfefd1a17f9", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 12490, "upload_time": "2018-11-03T04:43:40", "url": "https://files.pythonhosted.org/packages/77/a1/9ceb091ef182520590d75658a9f6e55879047f1eb6f29ef5bc69a7b00ec5/pyfortified_logging-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5dc3a0f82ff874fc91af758515fbe0bb", "sha256": "3399366edc29982311de270a8f020dd395b7f59a243cfe246b13ef67c96955ce" }, "downloads": -1, "filename": "pyfortified-logging-0.2.1.tar.gz", "has_sig": false, "md5_digest": "5dc3a0f82ff874fc91af758515fbe0bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31316, "upload_time": "2018-11-03T04:43:38", "url": "https://files.pythonhosted.org/packages/43/af/51b1347af203ee9f2eafd762472e7736274a3507c2f0141ae29dd33ef3a3/pyfortified-logging-0.2.1.tar.gz" } ] }