.. image:: https://github.com/ome/omero-webtest/workflows/OMERO/badge.svg
:target: https://github.com/ome/omero-webtest/actions
.. image:: https://badge.fury.io/py/omero-webtest.svg
:target: https://badge.fury.io/py/omero-webtest
OMERO.webtest
=============
OMERO.web app for various prototypes and examples.
This was removed from the main OMERO.web in the 5.0.6 release of OMERO.
Requirements
------------
* OMERO.web 5.6 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/>`_:
::
$ pip install omero-webtest
Add webtest custom app to your installed web apps:
::
$ omero config append omero.web.apps '"omero_webtest"'
Optional: install example webclient plugins:
::
$ omero config append omero.web.ui.right_plugins '["ROIs", "webtest/webclient_plugins/right_plugin.rois.js.html", "image_roi_tab"]'
$ omero config append omero.web.ui.center_plugins '["Split View", "webtest/webclient_plugins/center_plugin.splitview.js.html", "split_view_panel"]'
Now restart OMERO.web as normal.
Examples
--------
Existing examples are available on the following URLs:
::
https://HOST/webtest/examples/IMAGE_ID/embed_big_image.html
https://HOST/webtest/examples/IMAGE_ID/embed_viewer.html
**Note**: IMAGE_ID can be obtained from public images.
New templates can be added to templates/webtest/examples. New template can benefit from dynamic variables: {{ host_name }} and {{ image_id }} passed through URL.
Included: Rendered template that can be saved locally for further testing as an absolute uri.
Release process
---------------
This repository uses `bump2version <https://pypi.org/project/bump2version/>`_ to manage version numbers.
To tag a release run::
$ bumpversion release
This will remove the ``.dev0`` suffix from the current version, commit, and tag the release.
To switch back to a development version run::
$ bumpversion --no-tag [major|minor|patch]
specifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.
Remember to ``git push`` all commits and tags.
License
-------
OMERO.webtest is released under the AGPL.
Copyright
---------
2016-2020, The Open Microscopy Environment
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/omero-webtest",
"name": "omero-webtest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "OMERO.web,plugin",
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/4e/bd/4a790f5be3444ba5f912127e2fb6ef7c54c19182fb6b2f5233d362745dcc/omero-webtest-0.4.2.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/ome/omero-webtest/workflows/OMERO/badge.svg\n :target: https://github.com/ome/omero-webtest/actions\n\n.. image:: https://badge.fury.io/py/omero-webtest.svg\n :target: https://badge.fury.io/py/omero-webtest\n\n\nOMERO.webtest\n=============\nOMERO.web app for various prototypes and examples.\nThis was removed from the main OMERO.web in the 5.0.6 release of OMERO.\n\nRequirements\n------------\n\n* OMERO.web 5.6 or newer.\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\n::\n\n $ pip install omero-webtest\n\nAdd webtest custom app to your installed web apps:\n\n::\n\n $ omero config append omero.web.apps '\"omero_webtest\"'\n\nOptional: install example webclient plugins:\n\n::\n\n $ omero config append omero.web.ui.right_plugins '[\"ROIs\", \"webtest/webclient_plugins/right_plugin.rois.js.html\", \"image_roi_tab\"]'\n $ omero config append omero.web.ui.center_plugins '[\"Split View\", \"webtest/webclient_plugins/center_plugin.splitview.js.html\", \"split_view_panel\"]'\n\nNow restart OMERO.web as normal.\n\n\nExamples\n--------\n\nExisting examples are available on the following URLs:\n\n::\n\n https://HOST/webtest/examples/IMAGE_ID/embed_big_image.html\n https://HOST/webtest/examples/IMAGE_ID/embed_viewer.html\n\n**Note**: IMAGE_ID can be obtained from public images.\n\nNew templates can be added to templates/webtest/examples. New template can benefit from dynamic variables: {{ host_name }} and {{ image_id }} passed through URL.\n\nIncluded: Rendered template that can be saved locally for further testing as an absolute uri.\n\nRelease process\n---------------\n\nThis repository uses `bump2version <https://pypi.org/project/bump2version/>`_ to manage version numbers.\nTo tag a release run::\n\n $ bumpversion release\n\nThis will remove the ``.dev0`` suffix from the current version, commit, and tag the release.\n\nTo switch back to a development version run::\n\n $ bumpversion --no-tag [major|minor|patch]\n\nspecifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.\n\nRemember to ``git push`` all commits and tags.\n\nLicense\n-------\n\nOMERO.webtest is released under the AGPL.\n\nCopyright\n---------\n\n2016-2020, The Open Microscopy Environment\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A Python plugin for OMERO.web",
"version": "0.4.2",
"project_urls": {
"Download": "https://github.com/ome/omero-webtest/archive/v0.4.2.tar.gz",
"Homepage": "https://github.com/ome/omero-webtest"
},
"split_keywords": [
"omero.web",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4781ddea63a2a258a202c75ded3e101e799a6ad67b69fcedc966eefefa87a5c1",
"md5": "9c65b5c1e4aca95c73a603ea89b7e6de",
"sha256": "8e4407cfb9bb3f8f26cc6a8c71c554e7c779e0d547549c08b3ab236d84e88b56"
},
"downloads": -1,
"filename": "omero_webtest-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c65b5c1e4aca95c73a603ea89b7e6de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 89666,
"upload_time": "2023-06-15T12:48:30",
"upload_time_iso_8601": "2023-06-15T12:48:30.887059Z",
"url": "https://files.pythonhosted.org/packages/47/81/ddea63a2a258a202c75ded3e101e799a6ad67b69fcedc966eefefa87a5c1/omero_webtest-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ebd4a790f5be3444ba5f912127e2fb6ef7c54c19182fb6b2f5233d362745dcc",
"md5": "94e9a9844a261c76cd74bc6a1702b9d6",
"sha256": "1fff9513ddd2c4e5c03d14a6092f88ccee8f53d9fa873782c2d29e80d3a10f31"
},
"downloads": -1,
"filename": "omero-webtest-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "94e9a9844a261c76cd74bc6a1702b9d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 62776,
"upload_time": "2023-06-15T12:48:32",
"upload_time_iso_8601": "2023-06-15T12:48:32.762607Z",
"url": "https://files.pythonhosted.org/packages/4e/bd/4a790f5be3444ba5f912127e2fb6ef7c54c19182fb6b2f5233d362745dcc/omero-webtest-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 12:48:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "omero-webtest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "omero-webtest"
}
JSON
