{ "info": { "author": "Steve Dower", "author_email": "steve.dower@python.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: Microsoft :: Windows", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# reportabug\nA Python tool for collecting information when reporting bugs.\n\n[![PyPI version](https://badge.fury.io/py/reportabug.svg)](https://pypi.org/project/reportabug)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![Build Status](https://dev.azure.com/stevedower/ReportABug/_apis/build/status/ReportABug-CI)](https://dev.azure.com/stevedower/ReportABug/_build/latest?definitionId=28)\n\n## Installation\n\n```\npython -m pip install git+https://github.com/zooba/reportabug\npython -m pip install reportabug\n```\n\nInstalling directly from GitHub is recommended for now, as not every improvement\nis being released to PyPI.\n\n## Usage\n\n```\nreportabug [--format FORMAT] [MODULE NAMES]\npython -m reportabug [--format FORMAT] [MODULE NAMES]\n```\n\nThe report will be output to the console. You should copy-paste this into\nyour bug report.\n\n`FORMAT` may be one of `ghmarkdown` (default, also `ghmd` and `ghm`),\n`markdown` (also `md` and `m`), or `text` (also `t`). In general, `ghmarkdown`\nwill be valid and optimised for GitHub issues, while `markdown` will be more\npure.\n\nOn Windows, you can pipe to `clip.exe` to store the output on the clipboard.\n\n```\npython -m reportabug [MODULE NAMES] | clip\n```\n\nSome personal information will be hidden, though a non-reversible summary of its contents is included as this information may be important. **Remember to review your report for personal information before sharing.**\n\nSee [issue #1](https://github.com/zooba/reportabug/issues/1) for an example report.\n\n## API\n\nCurrently, `reportabug` has no public API. However, modules specified on the command line may expose a `_reportabug_info` generator to provide additional info.\n\n```python\ndef _reportabug_info(arg):\n yield 'summary', 'summary line of text'\n yield 'key', VALUE\n```\n\nEach key/value pair will be added to the result section for the module. If the `summary` key exists, it will be added to a summary section if one exists for the selected output format.\n\nThe `arg` parameter is currently undefined, but may be used in future.\n\n## Contributing\n\nContributions are welcome. Feel free to file an issue or PR.\n\nRequests to add further information to the report should include supporting evidence, such as a bug that would have been diagnosed more quickly with the additional information.\n\n## Privacy\n\nNo information is transmitted by this tool. Please review and remove personal information from the generated reports before sharing with other people.\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/zooba/reportabug", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "reportabug", "package_url": "https://pypi.org/project/reportabug/", "platform": "", "project_url": "https://pypi.org/project/reportabug/", "project_urls": { "Homepage": "https://github.com/zooba/reportabug" }, "release_url": "https://pypi.org/project/reportabug/0.19.85.2/", "requires_dist": null, "requires_python": ">=3.6", "summary": "\"A Python tool for collecting information when reporting bugs.\"", "version": "0.19.85.2" }, "last_serial": 4988509, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "ea5cc17428c24966d8077a4b9658a08a", "sha256": "037aedc19633894409d75c6dc32a5ce5cbe6dd9f00ee45eba37c61c35875565d" }, "downloads": -1, "filename": "reportabug-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ea5cc17428c24966d8077a4b9658a08a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5868, "upload_time": "2019-01-30T05:23:22", "url": "https://files.pythonhosted.org/packages/d0/63/b5e92c6c34bdcae9fc4a8f35133ab37f83cc94631e7164d62926aecb2e9d/reportabug-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "509aef1f0fe34319a530c7a7c23568cb", "sha256": "f82d4cee2aab85c0c14649c6fd86026c45ad237bbe8770ce7d9860dbafedbb55" }, "downloads": -1, "filename": "reportabug-0.1.tar.gz", "has_sig": false, "md5_digest": "509aef1f0fe34319a530c7a7c23568cb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4735, "upload_time": "2019-01-30T05:23:24", "url": "https://files.pythonhosted.org/packages/48/42/a96e4c75d2921e4a22001d8ba5776019a0fbf2f329c69847358000b91b7a/reportabug-0.1.tar.gz" } ], "0.19.85.2": [ { "comment_text": "", "digests": { "md5": "9a5a2c1c81f3cff6ac9d494183897311", "sha256": "28bb31d0cc016aeac3b13b35ccc4e79572398d17cbf63e960806532159773337" }, "downloads": -1, "filename": "reportabug-0.19.85.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9a5a2c1c81f3cff6ac9d494183897311", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 6847, "upload_time": "2019-03-26T16:49:58", "url": "https://files.pythonhosted.org/packages/fb/c4/9aaeacf486198f8746d9862b106e0d58862206ea03f44f094784c2cd6807/reportabug-0.19.85.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7530ecb1460effb16d787b183638d59a", "sha256": "c723f2215fafe98066a7f176a70e024fc9461e502e8e76fa51c62b565a911998" }, "downloads": -1, "filename": "reportabug-0.19.85.2.tar.gz", "has_sig": false, "md5_digest": "7530ecb1460effb16d787b183638d59a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6349, "upload_time": "2019-03-26T16:49:59", "url": "https://files.pythonhosted.org/packages/7b/56/de93bc567b29731a7bb00dc12c7f1d0f955e4b7b2d7f328a7a53891e53c3/reportabug-0.19.85.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9a5a2c1c81f3cff6ac9d494183897311", "sha256": "28bb31d0cc016aeac3b13b35ccc4e79572398d17cbf63e960806532159773337" }, "downloads": -1, "filename": "reportabug-0.19.85.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9a5a2c1c81f3cff6ac9d494183897311", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 6847, "upload_time": "2019-03-26T16:49:58", "url": "https://files.pythonhosted.org/packages/fb/c4/9aaeacf486198f8746d9862b106e0d58862206ea03f44f094784c2cd6807/reportabug-0.19.85.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7530ecb1460effb16d787b183638d59a", "sha256": "c723f2215fafe98066a7f176a70e024fc9461e502e8e76fa51c62b565a911998" }, "downloads": -1, "filename": "reportabug-0.19.85.2.tar.gz", "has_sig": false, "md5_digest": "7530ecb1460effb16d787b183638d59a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6349, "upload_time": "2019-03-26T16:49:59", "url": "https://files.pythonhosted.org/packages/7b/56/de93bc567b29731a7bb00dc12c7f1d0f955e4b7b2d7f328a7a53891e53c3/reportabug-0.19.85.2.tar.gz" } ] }