{ "info": { "author": "Tyler Burdsall", "author_email": "tylerburdsall@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# imghighlight\n\nA tiny Python 3 wrapper to make highlighting portions of an image much easier\n\n## Installation\n\nInstalling is best done using `pip`:\n\n```shell\npython3 -m pip install pyhighlight\n```\n\nAnother option is to clone the repo and copy the `pyhighlight` module folder (containing `__init__.py`) into your project directory.\n\n## Usage\n\nThe wrapper utilizes three functions:\n\n| Name | Description |\n| -----|------------ |\n| `pyhighlight(image_path)` | The constructor, takes in the base image's file path |\n| `highlight(points, color, transparency)` | Highlights a portion of the image. |\n| `save(output_path)` | Saves the generated image to the file path specified\n\n## Example\n\nLet's say you have an image of some buildings you want to highlight:\n\n![Example buildings](example_buildings.png)\n\nAssuming you know the points on the image that you want to highlight, a tiny script can be written to easily generate a new image with those buildings highlighted:\n\n```python\nimport pyhighlight as ph\n\n# Assuming we want to highlight buildings A, B, and C\n# from the example image\npoints = {\n 'A': [[45, 156], [155, 50], [156, 160]],\n 'B': [[37, 253], [206, 253], [206, 276], [90, 276], [90, 297], [206, 297],\n [206, 330], [90, 330], [90, 352], [210, 352], [210, 386], [37, 386]],\n 'C': [[352, 57], [518, 57], [518, 128], [410, 128], [410, 190], [352, 190]]\n}\n\ntest = ph.pyhighlight('example_buildings.png')\ntest.highlight(points['A'])\ntest.highlight(points['B'], color='red', transparency=0.5)\ntest.highlight(points['C'], color='green')\n\ntest.save('example.png')\n```\n\nThe final result:\n\n![Final result](example.png)\n\n## License\n\nMIT License\n\nCopyright (c) 2018 Tyler Burdsall\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\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/iamtheburd/pyhighlight", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "pyhighlight", "package_url": "https://pypi.org/project/pyhighlight/", "platform": "", "project_url": "https://pypi.org/project/pyhighlight/", "project_urls": { "Homepage": "https://github.com/iamtheburd/pyhighlight" }, "release_url": "https://pypi.org/project/pyhighlight/1.0.2/", "requires_dist": null, "requires_python": "", "summary": "Tiny package to help highlight portions of an image with matplotlib", "version": "1.0.2" }, "last_serial": 4038108, "releases": { "1.0.2": [ { "comment_text": "", "digests": { "md5": "78b70d526a18ce318c45567fc52cf41e", "sha256": "509110d35702d900ce887862402477131164e32d562b71357e15ab27ad8e51ae" }, "downloads": -1, "filename": "pyhighlight-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "78b70d526a18ce318c45567fc52cf41e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3449, "upload_time": "2018-07-07T00:08:53", "url": "https://files.pythonhosted.org/packages/4c/f6/e3fef00cb25d3367963b7ce1bca22644bf3dc2bf3574f62b6589f2bea763/pyhighlight-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cf4cd7963e3d640fc50413d2777ba15f", "sha256": "e594c80c5f0e33fca16d36c8e0c714080e4f72d6c843314e577b95e6fd1ddb79" }, "downloads": -1, "filename": "pyhighlight-1.0.2.tar.gz", "has_sig": false, "md5_digest": "cf4cd7963e3d640fc50413d2777ba15f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3430, "upload_time": "2018-07-07T00:08:54", "url": "https://files.pythonhosted.org/packages/6b/02/7a5413f865e96111e0cfb53c57eba2df3324b9111dbc2f319ad3274036ac/pyhighlight-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "78b70d526a18ce318c45567fc52cf41e", "sha256": "509110d35702d900ce887862402477131164e32d562b71357e15ab27ad8e51ae" }, "downloads": -1, "filename": "pyhighlight-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "78b70d526a18ce318c45567fc52cf41e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3449, "upload_time": "2018-07-07T00:08:53", "url": "https://files.pythonhosted.org/packages/4c/f6/e3fef00cb25d3367963b7ce1bca22644bf3dc2bf3574f62b6589f2bea763/pyhighlight-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cf4cd7963e3d640fc50413d2777ba15f", "sha256": "e594c80c5f0e33fca16d36c8e0c714080e4f72d6c843314e577b95e6fd1ddb79" }, "downloads": -1, "filename": "pyhighlight-1.0.2.tar.gz", "has_sig": false, "md5_digest": "cf4cd7963e3d640fc50413d2777ba15f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3430, "upload_time": "2018-07-07T00:08:54", "url": "https://files.pythonhosted.org/packages/6b/02/7a5413f865e96111e0cfb53c57eba2df3324b9111dbc2f319ad3274036ac/pyhighlight-1.0.2.tar.gz" } ] }