{ "info": { "author": "James Parkhurst", "author_email": "james.parkhurst@diamond.ac.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Utilities" ], "description": "# halerror\n> The best python exception library\n\n[![PyPI](https://img.shields.io/pypi/v/halerror.svg)](https://pypi.org/project/halerror/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/halerror.svg)](https://pypi.org/project/halerror/)\n![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)\n[![Documentation Status](https://readthedocs.org/projects/halerror/badge/?version=latest)](https://halerror.readthedocs.io/en/latest/)\n[![Travis (.org)](https://img.shields.io/travis/jmp1985/halerror.svg)](https://travis-ci.org/jmp1985/halerror)\n[![Codecov](https://img.shields.io/codecov/c/github/jmp1985/halerror.svg)](https://codecov.io/gh/jmp1985/halerror)\n[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/jmp1985/halerror.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jmp1985/halerror/context:python)\n[![Total alerts](https://img.shields.io/lgtm/alerts/g/jmp1985/halerror.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jmp1985/halerror/alerts/)\n\nThis python library implements a sci-fi exception class!\n\n## Installation\n\nThe package is available from [PyPI](https://pypi.org/project/halerror/0.4.0/).\nTo install using pip, do the following:\n\n```sh\npip install halerror\n```\n\nTo install from source, clone this repository and then do the following:\n\n```sh\npython setup.py install\n```\n\n## Testing\n\nTo run the tests, clone this repository and the do the following:\n\n```sh\npython setup.py test\n```\n\n## Building the documentation\n\nTo build the documenation, clone this repository and the do the following:\n\n```sh\npip install -e .[build_sphinx]\npython setup.py build_sphinx\n```\n\n## Usage examples\n\nThe exception class can be used as follows:\n\n```python\nfrom halerror import HalError\n\ndef open_pod_bay_doors():\n raise HalError(\"Open the pod bay doors, HAL.\")\n\nopen_pod_bay_doors()\n```\n\nThis will result in the following error output, where ${NAME} is the username\nof the person running the software:\n\n```\nhalerror.HalError: Open the pod bay doors, HAL\n\nI'm sorry, ${NAME}. I'm afraid I can't do that.\n```\n\nHaving all your exceptions formatted like this is as easy as adding the\nfollowing lines to your code\n\n```python\nfrom halerror import HalError\n\ntry:\n open_pod_bay_doors()\nexcept Exception as error:\n raise HalError(error) from error\n```\n\n## Documentation\n\nYou can find the full documentation on [Read the Docs](https://halerror.readthedocs.io/en/latest).\n\n## Issues\n\nPlease use the [GitHub issue tracker](https://github.com/jmp1985/halerror/issues) to submit bugs or request features.\n\n## License\n\nCopyright James Parkhurst, 2019.\n\nDistributed under the terms of the BSD license, halerror is free and open source software.\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/jmp1985/halerror", "keywords": "exception,HAL-9000", "license": "BSD license", "maintainer": "", "maintainer_email": "", "name": "halerror", "package_url": "https://pypi.org/project/halerror/", "platform": "unix", "project_url": "https://pypi.org/project/halerror/", "project_urls": { "Homepage": "https://github.com/jmp1985/halerror", "Source": "https://github.com/jmp1985/halerror", "Tracker": "https://github.com/jmp1985/halerror/issues" }, "release_url": "https://pypi.org/project/halerror/0.4.1/", "requires_dist": [ "sphinx ; extra == 'build_sphinx'", "sphinx-rtd-theme ; extra == 'build_sphinx'" ], "requires_python": "", "summary": "The best python exception library!", "version": "0.4.1" }, "last_serial": 5145196, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "6e0d3a1422674523c0f22ec4b6ba1e44", "sha256": "aef094312d4e9708d6aca038822e1bf3f54e064eff944214f300c22f81b7d6ff" }, "downloads": -1, "filename": "halerror-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "6e0d3a1422674523c0f22ec4b6ba1e44", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2421, "upload_time": "2019-04-13T14:54:47", "url": "https://files.pythonhosted.org/packages/6d/17/d4749740b66fa94b246a5eccda1a0d454bbf5d8789f46312e8ad23b35ae1/halerror-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "78fb10e2cb4ae471090e72b3758c116c", "sha256": "ed2e7bfe1ca18bdfd1c35f611a37892a9b03688f538379ae4cc0d29267d954ba" }, "downloads": -1, "filename": "halerror-0.1.tar.gz", "has_sig": false, "md5_digest": "78fb10e2cb4ae471090e72b3758c116c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1576, "upload_time": "2019-04-13T14:54:49", "url": "https://files.pythonhosted.org/packages/f2/76/65c52c6c80ecff84cb2e7c0f71681fa556111ce42d604704b317b31a8145/halerror-0.1.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "5a2e003e1aa611adc80925009d300e8d", "sha256": "1f54a89a9a50170b5cda7182628fc40e9455cf255d21202cd79c0e996067d77e" }, "downloads": -1, "filename": "halerror-0.4.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5a2e003e1aa611adc80925009d300e8d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3862, "upload_time": "2019-04-15T12:35:38", "url": "https://files.pythonhosted.org/packages/8c/1e/138a734fec53475e112950eaaeaac584ab09b2a976147554ab42cadfe4a7/halerror-0.4.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "43ab6b0ce535de0325219bb42450ff71", "sha256": "e48d0e509dc447ce8839511689b1c77c1323b4c112b691b0c7b9303b17d02012" }, "downloads": -1, "filename": "halerror-0.4.0.tar.gz", "has_sig": false, "md5_digest": "43ab6b0ce535de0325219bb42450ff71", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3750, "upload_time": "2019-04-15T12:35:39", "url": "https://files.pythonhosted.org/packages/a7/2a/7007a79f833235b8db46137bda93bcdd67a7e28d56ac1b13c54ab57f78d5/halerror-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "807064143eac03b66614da17060db63e", "sha256": "223aa8fe898cbb406e11f094fe65557fde210aa2144bc5cfbef03c975761f665" }, "downloads": -1, "filename": "halerror-0.4.1-py3-none-any.whl", "has_sig": false, "md5_digest": "807064143eac03b66614da17060db63e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3927, "upload_time": "2019-04-15T14:44:35", "url": "https://files.pythonhosted.org/packages/4a/6f/d1acb7b4beae93eac3544fa11c73aacf0f390e46130698b02ef5db320dc2/halerror-0.4.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8e55e92948acb7fda3f6448bc4cefdb1", "sha256": "b5b97a5e05dcbb022c7b884564ac268b83f1232f365cf6747b1ac61f6f156146" }, "downloads": -1, "filename": "halerror-0.4.1.tar.gz", "has_sig": false, "md5_digest": "8e55e92948acb7fda3f6448bc4cefdb1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3836, "upload_time": "2019-04-15T14:44:36", "url": "https://files.pythonhosted.org/packages/29/7c/5302f069275ac3012df79440201dc9951176f97f9841ba0c13413beb8392/halerror-0.4.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "807064143eac03b66614da17060db63e", "sha256": "223aa8fe898cbb406e11f094fe65557fde210aa2144bc5cfbef03c975761f665" }, "downloads": -1, "filename": "halerror-0.4.1-py3-none-any.whl", "has_sig": false, "md5_digest": "807064143eac03b66614da17060db63e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3927, "upload_time": "2019-04-15T14:44:35", "url": "https://files.pythonhosted.org/packages/4a/6f/d1acb7b4beae93eac3544fa11c73aacf0f390e46130698b02ef5db320dc2/halerror-0.4.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8e55e92948acb7fda3f6448bc4cefdb1", "sha256": "b5b97a5e05dcbb022c7b884564ac268b83f1232f365cf6747b1ac61f6f156146" }, "downloads": -1, "filename": "halerror-0.4.1.tar.gz", "has_sig": false, "md5_digest": "8e55e92948acb7fda3f6448bc4cefdb1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3836, "upload_time": "2019-04-15T14:44:36", "url": "https://files.pythonhosted.org/packages/29/7c/5302f069275ac3012df79440201dc9951176f97f9841ba0c13413beb8392/halerror-0.4.1.tar.gz" } ] }