imshowTk
===============================
.. image:: https://github.com/SciKit-Surgery/imshowTk/raw/master/project-icon.png
:height: 128px
:width: 128px
:target: https://github.com/SciKit-Surgery/imshowTk
:alt: Logo
|
.. image:: https://github.com/SciKit-Surgery/imshowTk/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/SciKit-Surgery/imshowTk/actions/
:alt: GitHub CI test status
.. image:: https://coveralls.io/repos/github/SciKit-Surgery/imshowTk/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/SciKit-Surgery/imshowTk?branch=master
:alt: Test coverage
.. image:: https://readthedocs.org/projects/imshowTk/badge/?version=latest
:target: http://imshowTk.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: CODE_OF_CONDUCT.md
.. image:: https://img.shields.io/badge/Cite-SciKit--Surgery-informational
:target: https://doi.org/10.1007/s11548-020-02180-5
:alt: The SciKit-Surgery paper
.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social
:target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw
:alt: Follow scikit_surgery on twitter
Author: Stephen Thompson
imshowTk is a zero dependency alternative to opencv's imshow function. It was developed to allow us to show an image window when using opencv-headless and don't want to use a larger UI library. It uses tkinter which comes as standard in most Python installations.
imshowTk is part of the `SciKit-Surgery`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.
Basic use case
::
from from imshowtk.imshowtk import ImshowTk
imshow = ImshowTk()
frame = cv2.imread('project-icon.png')
imshow.imshow(frame)
del imshow
Developing
----------
Cloning
^^^^^^^
You can clone the repository using the following command:
::
git clone https://github.com/SciKit-Surgery/imshowTk
Running tests
^^^^^^^^^^^^^
Pytest is used for running unit tests:
::
pip install pytest
python -m pytest
Linting
^^^^^^^
This code conforms to the PEP8 standard. Pylint can be used to analyse the code:
::
pip install pylint
pylint --rcfile=tests/pylintrc imshowtk
Installing
----------
You can pip install directly from the repository as follows:
::
pip install git+https://github.com/SciKit-Surgery/imshowTk
Contributing
^^^^^^^^^^^^
Please see the `contributing guidelines`_.
Useful links
^^^^^^^^^^^^
* `Source code repository`_
* `Documentation`_
Licensing and copyright
-----------------------
Copyright 2023 University College London.
imshowTk is released under the BSD-3 license. Please see the `license file`_ for details.
Acknowledgements
----------------
Supported by `Wellcome`_ and `EPSRC`_.
.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss
.. _`source code repository`: https://github.com/SciKit-Surgery/imshowTk
.. _`Documentation`: https://imshowTk.readthedocs.io
.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery
.. _`University College London (UCL)`: http://www.ucl.ac.uk/
.. _`Wellcome`: https://wellcome.ac.uk/
.. _`EPSRC`: https://www.epsrc.ac.uk/
.. _`contributing guidelines`: https://github.com/SciKit-Surgery/imshowTk/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/imshowTk/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/SciKit-Surgery/imshowTk",
"name": "imshowTk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "medical imaging",
"author": "Stephen Thompson",
"author_email": "s.thompson@ucl.ac.uk",
"download_url": "",
"platform": null,
"description": "imshowTk\n===============================\n\n.. image:: https://github.com/SciKit-Surgery/imshowTk/raw/master/project-icon.png\n :height: 128px\n :width: 128px\n :target: https://github.com/SciKit-Surgery/imshowTk\n :alt: Logo\n\n|\n\n\n.. image:: https://github.com/SciKit-Surgery/imshowTk/workflows/.github/workflows/ci.yml/badge.svg\n :target: https://github.com/SciKit-Surgery/imshowTk/actions/\n :alt: GitHub CI test status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/imshowTk/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/SciKit-Surgery/imshowTk?branch=master\n :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/imshowTk/badge/?version=latest\n :target: http://imshowTk.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\n :target: CODE_OF_CONDUCT.md\n\n.. image:: https://img.shields.io/badge/Cite-SciKit--Surgery-informational\n :target: https://doi.org/10.1007/s11548-020-02180-5\n :alt: The SciKit-Surgery paper\n\n.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social\n :target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw\n :alt: Follow scikit_surgery on twitter\n\n\nAuthor: Stephen Thompson\n\nimshowTk is a zero dependency alternative to opencv's imshow function. It was developed to allow us to show an image window when using opencv-headless and don't want to use a larger UI library. It uses tkinter which comes as standard in most Python installations.\n\nimshowTk is part of the `SciKit-Surgery`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.\n\nBasic use case\n::\n\n from from imshowtk.imshowtk import ImshowTk\n imshow = ImshowTk()\n frame = cv2.imread('project-icon.png')\n imshow.imshow(frame)\n del imshow\n\n\nDeveloping\n----------\n\nCloning\n^^^^^^^\n\nYou can clone the repository using the following command:\n\n::\n\n git clone https://github.com/SciKit-Surgery/imshowTk\n\n\nRunning tests\n^^^^^^^^^^^^^\nPytest is used for running unit tests:\n::\n\n pip install pytest\n python -m pytest\n\n\nLinting\n^^^^^^^\n\nThis code conforms to the PEP8 standard. Pylint can be used to analyse the code:\n\n::\n\n pip install pylint\n pylint --rcfile=tests/pylintrc imshowtk\n\n\nInstalling\n----------\n\nYou can pip install directly from the repository as follows:\n\n::\n\n pip install git+https://github.com/SciKit-Surgery/imshowTk\n\n\n\nContributing\n^^^^^^^^^^^^\n\nPlease see the `contributing guidelines`_.\n\n\nUseful links\n^^^^^^^^^^^^\n\n* `Source code repository`_\n* `Documentation`_\n\n\nLicensing and copyright\n-----------------------\n\nCopyright 2023 University College London.\nimshowTk is released under the BSD-3 license. Please see the `license file`_ for details.\n\n\nAcknowledgements\n----------------\n\nSupported by `Wellcome`_ and `EPSRC`_.\n\n\n.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss\n.. _`source code repository`: https://github.com/SciKit-Surgery/imshowTk\n.. _`Documentation`: https://imshowTk.readthedocs.io\n.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery\n.. _`University College London (UCL)`: http://www.ucl.ac.uk/\n.. _`Wellcome`: https://wellcome.ac.uk/\n.. _`EPSRC`: https://www.epsrc.ac.uk/\n.. _`contributing guidelines`: https://github.com/SciKit-Surgery/imshowTk/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/imshowTk/blob/master/LICENSE\n\n\n\n",
"bugtrack_url": null,
"license": "BSD-3 license",
"summary": "A lightweight replacement for openCV imshow using Tk",
"version": "1.0.0",
"split_keywords": [
"medical",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "872dc63ab86c3fdab212f77f0c49f606db3a29c05e5295631aeaff30f441139d",
"md5": "74e6af79015ec0d36ce5b4a7e7a01d7f",
"sha256": "dc18d412ee1062b836de13d40b4d3cd9f146bf6ebb725e0d6d805032ea0eb2af"
},
"downloads": -1,
"filename": "imshowTk-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "74e6af79015ec0d36ce5b4a7e7a01d7f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 10723,
"upload_time": "2023-04-27T16:17:55",
"upload_time_iso_8601": "2023-04-27T16:17:55.472914Z",
"url": "https://files.pythonhosted.org/packages/87/2d/c63ab86c3fdab212f77f0c49f606db3a29c05e5295631aeaff30f441139d/imshowTk-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 16:17:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "SciKit-Surgery",
"github_project": "imshowTk",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "imshowtk"
}
JSON
