{ "info": { "author": "Kaarel Ratas", "author_email": "kaarel@thinnect.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: System :: Logging", "Topic :: Utilities" ], "description": "# `logging-toolbox`\n\n[![Build Status](https://travis-ci.com/thinnect/logging-toolbox.svg?branch=master)](https://travis-ci.com/thinnect/logging-toolbox)\n\nThe `logging-toolbox` module contains useful functions to help the user\nwith logging recurring things like command-line arguments and dependencies\non startup.\n\n## Usage\n\n### Logging program arguments and dependencies\n\nSuppose we have a Python program that has the dependencies `dep1` and `dep2`,\nand takes the command-line arguments `--server-url`, `--one-argument` and\n`--some-hex-value`. We'll assume the module the program is a part of is\ncalled `simple_program`. Upon startup, we can log the versions of our\ndependencies and all arguments.\n\n```python\nfrom .utils import get_args, setup_logging\n\nfrom logging_toolbox.startup import startup_log\nfrom logging_toolbox.utils import clean_url\n\n\nif __name__ == '__main__':\n arguments = get_args()\n setup_logging()\n\n startup_log(arguments,\n critical_modules=['simple_program', 'dep1', 'dep2'],\n cleaners={'server_url': clean_url,\n 'some_hex_value': '0x{:04X}'.format})\n```\n\nThis should log something like:\n\n```text\n=================CONFIG=================\n----------------Versions----------------\nsimple_program : UNKNOWN\ndep1 : 0.3.2.dev23\ndep2 : 1.0.1\n---------------Arguments----------------\none_argument : argument value\nserver_url : https://user:******@server/\nsome_hex_value : 0x02FF\n=======================================\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/thinnect/logging-toolbox", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "logging-toolbox", "package_url": "https://pypi.org/project/logging-toolbox/", "platform": "", "project_url": "https://pypi.org/project/logging-toolbox/", "project_urls": { "Homepage": "https://github.com/thinnect/logging-toolbox" }, "release_url": "https://pypi.org/project/logging-toolbox/0.2.0/", "requires_dist": [ "six" ], "requires_python": "", "summary": "logging-toolbox", "version": "0.2.0" }, "last_serial": 5374806, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "809a52dc39f1ce527d36ec38ec4421b6", "sha256": "2f89afae487d10bddd07af7c0b58ada9d4ccf3b2f50b87f5a71086668e654878" }, "downloads": -1, "filename": "logging_toolbox-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "809a52dc39f1ce527d36ec38ec4421b6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6498, "upload_time": "2019-06-07T09:04:14", "url": "https://files.pythonhosted.org/packages/14/6f/c4a65b2c57ebbc3b2b7433d2c256df28f5419f3c3ceada0c40bab53cfde6/logging_toolbox-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d7ddf83cdd3457bcd1e47c524d0c58a3", "sha256": "938a6914228e6911eec56e58f7b798ad3a4749d49f103a43bec80cc0ce54e92e" }, "downloads": -1, "filename": "logging-toolbox-0.1.0.tar.gz", "has_sig": false, "md5_digest": "d7ddf83cdd3457bcd1e47c524d0c58a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4284, "upload_time": "2019-06-07T09:04:16", "url": "https://files.pythonhosted.org/packages/1e/3a/78274d29051e3af89470b93c7d542e0a3a1998a4f56027cca5e64eef8fee/logging-toolbox-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "019e1a15d79d1ecbc6204d2298629cdb", "sha256": "3b18fe2aed74e2404e7e95bc55c8f60cb7cf71ba1289950fb75cfdedb2308339" }, "downloads": -1, "filename": "logging_toolbox-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "019e1a15d79d1ecbc6204d2298629cdb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6787, "upload_time": "2019-06-08T08:30:27", "url": "https://files.pythonhosted.org/packages/db/31/6d22c66f4eecfa1da969c0f824da15f423b117c4fbbc40c70d65eec4a529/logging_toolbox-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "41b1222affd1559606045f61ee20c9e2", "sha256": "7f198289ce76580bfd5423f8c416cc6e4549b911260bab641e022925c5909dfa" }, "downloads": -1, "filename": "logging-toolbox-0.2.0.tar.gz", "has_sig": false, "md5_digest": "41b1222affd1559606045f61ee20c9e2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4600, "upload_time": "2019-06-08T08:30:28", "url": "https://files.pythonhosted.org/packages/e8/77/22f785a054c9cfb510e1b6ed03d02364288fc489e263d6c78b0ab11ec8e4/logging-toolbox-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "019e1a15d79d1ecbc6204d2298629cdb", "sha256": "3b18fe2aed74e2404e7e95bc55c8f60cb7cf71ba1289950fb75cfdedb2308339" }, "downloads": -1, "filename": "logging_toolbox-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "019e1a15d79d1ecbc6204d2298629cdb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6787, "upload_time": "2019-06-08T08:30:27", "url": "https://files.pythonhosted.org/packages/db/31/6d22c66f4eecfa1da969c0f824da15f423b117c4fbbc40c70d65eec4a529/logging_toolbox-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "41b1222affd1559606045f61ee20c9e2", "sha256": "7f198289ce76580bfd5423f8c416cc6e4549b911260bab641e022925c5909dfa" }, "downloads": -1, "filename": "logging-toolbox-0.2.0.tar.gz", "has_sig": false, "md5_digest": "41b1222affd1559606045f61ee20c9e2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4600, "upload_time": "2019-06-08T08:30:28", "url": "https://files.pythonhosted.org/packages/e8/77/22f785a054c9cfb510e1b6ed03d02364288fc489e263d6c78b0ab11ec8e4/logging-toolbox-0.2.0.tar.gz" } ] }