omero-iviewer


Nameomero-iviewer JSON
Version 0.14.0 PyPI version JSON
download
home_pagehttps://github.com/ome/omero-iviewer/
SummaryA Python plugin for OMERO.web
upload_time2024-05-21 10:13:13
maintainerNone
docs_urlNone
authorThe Open Microscopy Team
requires_python>=3
licenseAGPL-3.0
keywords omero.web plugin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://travis-ci.org/ome/omero-iviewer.svg?branch=master
    :target: https://travis-ci.org/ome/omero-iviewer

.. image:: https://badge.fury.io/py/omero-iviewer.svg
    :target: https://badge.fury.io/py/omero-iviewer

OMERO.iviewer
=============

An OMERO.web app for visualizing images in OMERO.


Requirements
============

* OMERO 5.6.0 or newer.


Installing from PyPI
====================

This section assumes that an OMERO.web is already installed.

Install the app using `pip <https://pip.pypa.io/en/stable/>`_:

NB: You need to ensure that you are running ``pip`` from the python environment
where ``omero-web`` is installed. Depending on your install, you may need to
call ``pip`` with, for example: ``/path/to/venv/bin/pip install ...``

::

    $ pip install -U omero-iviewer

Add iviewer custom app to your installed web apps:

::

    $ omero config append omero.web.apps '"omero_iviewer"'

To replace the default omero.web viewer:

::

    $ omero config set omero.web.viewer.view omero_iviewer.views.index

To enable the "open with" feature:

::

    $ omero config append omero.web.open_with '["omero_iviewer", "omero_iviewer_index",
      {"supported_objects":["images", "dataset", "well"],
       "script_url": "omero_iviewer/openwith.js", "label": "OMERO.iviewer"}]'

Now restart OMERO.web as normal.


Usage
=====

A guide to using OMERO.iviewer can be found on
https://omero-guides.readthedocs.io/en/latest/iviewer/docs/iviewer.html


License
-------

OMERO.iviewer is released under the AGPL.

Copyright
---------

2017-2022, The Open Microscopy Environment

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ome/omero-iviewer/",
    "name": "omero-iviewer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": null,
    "keywords": "OMERO.web, plugin",
    "author": "The Open Microscopy Team",
    "author_email": "ome-devel@lists.openmicroscopy.org.uk",
    "download_url": "https://files.pythonhosted.org/packages/ca/e6/6f6832af543314f70d3d87900b92b7701d862f84d76e9962dfc7f13a5ba0/omero_iviewer-0.14.0.tar.gz",
    "platform": null,
    "description": ".. image:: https://travis-ci.org/ome/omero-iviewer.svg?branch=master\n    :target: https://travis-ci.org/ome/omero-iviewer\n\n.. image:: https://badge.fury.io/py/omero-iviewer.svg\n    :target: https://badge.fury.io/py/omero-iviewer\n\nOMERO.iviewer\n=============\n\nAn OMERO.web app for visualizing images in OMERO.\n\n\nRequirements\n============\n\n* OMERO 5.6.0 or newer.\n\n\nInstalling from PyPI\n====================\n\nThis section assumes that an OMERO.web is already installed.\n\nInstall the app using `pip <https://pip.pypa.io/en/stable/>`_:\n\nNB: You need to ensure that you are running ``pip`` from the python environment\nwhere ``omero-web`` is installed. Depending on your install, you may need to\ncall ``pip`` with, for example: ``/path/to/venv/bin/pip install ...``\n\n::\n\n    $ pip install -U omero-iviewer\n\nAdd iviewer custom app to your installed web apps:\n\n::\n\n    $ omero config append omero.web.apps '\"omero_iviewer\"'\n\nTo replace the default omero.web viewer:\n\n::\n\n    $ omero config set omero.web.viewer.view omero_iviewer.views.index\n\nTo enable the \"open with\" feature:\n\n::\n\n    $ omero config append omero.web.open_with '[\"omero_iviewer\", \"omero_iviewer_index\",\n      {\"supported_objects\":[\"images\", \"dataset\", \"well\"],\n       \"script_url\": \"omero_iviewer/openwith.js\", \"label\": \"OMERO.iviewer\"}]'\n\nNow restart OMERO.web as normal.\n\n\nUsage\n=====\n\nA guide to using OMERO.iviewer can be found on\nhttps://omero-guides.readthedocs.io/en/latest/iviewer/docs/iviewer.html\n\n\nLicense\n-------\n\nOMERO.iviewer is released under the AGPL.\n\nCopyright\n---------\n\n2017-2022, The Open Microscopy Environment\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "A Python plugin for OMERO.web",
    "version": "0.14.0",
    "project_urls": {
        "Download": "https://github.com/ome/omero-iviewer/archive/v0.14.0.tar.gz",
        "Homepage": "https://github.com/ome/omero-iviewer/"
    },
    "split_keywords": [
        "omero.web",
        " plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8014674b73b74e0189f4de3220ff32f314e8da549ca93bf79e251a239d35cf10",
                "md5": "f91eb91d7fd868aae17bace615562cc3",
                "sha256": "e569d0358b35914dbe9c74719e7f50c5d122b979df6a81810b78448d79c9b435"
            },
            "downloads": -1,
            "filename": "omero_iviewer-0.14.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f91eb91d7fd868aae17bace615562cc3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 806658,
            "upload_time": "2024-05-21T10:13:07",
            "upload_time_iso_8601": "2024-05-21T10:13:07.900239Z",
            "url": "https://files.pythonhosted.org/packages/80/14/674b73b74e0189f4de3220ff32f314e8da549ca93bf79e251a239d35cf10/omero_iviewer-0.14.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cae66f6832af543314f70d3d87900b92b7701d862f84d76e9962dfc7f13a5ba0",
                "md5": "d414386c1a7d4ea4a40c95ccf3b1e0a7",
                "sha256": "3d9f710b8327bef1af47f1093387def8b617034f9ac969adcc7781ecd5bd0b96"
            },
            "downloads": -1,
            "filename": "omero_iviewer-0.14.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d414386c1a7d4ea4a40c95ccf3b1e0a7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 745899,
            "upload_time": "2024-05-21T10:13:13",
            "upload_time_iso_8601": "2024-05-21T10:13:13.960712Z",
            "url": "https://files.pythonhosted.org/packages/ca/e6/6f6832af543314f70d3d87900b92b7701d862f84d76e9962dfc7f13a5ba0/omero_iviewer-0.14.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-21 10:13:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ome",
    "github_project": "omero-iviewer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "omero-iviewer"
}
        
Elapsed time: 0.84966s