omero-tagsearch


Nameomero-tagsearch JSON
Version 4.2.0 PyPI version JSON
download
home_pagehttps://github.com/German-BioImaging/omero-tagsearch
SummaryOMERO webtagging tagsearch app
upload_time2024-06-02 13:14:41
maintainerTom Boissonnet
docs_urlNone
authorD.P.W. Russell
requires_python>=3
licenseAGPL-3.0
keywords omero.web webtagging tagsearch
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/German-BioImaging/omero-tagsearch/workflows/PyPI/badge.svg
   :target: https://github.com/German-BioImaging/omero-tagsearch/actions

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


OMERO.tagsearch
===============
OMERO.tagsearch is a plugin for `OMERO.web <https://github.com/ome/omero-web>`_ that enables searching of data using tags, with the search continuously refined as available search terms are entered and further term suggestions based on the entered terms are offered. 
This can be used in a way that is similar to navigating a file system hierarchy.

This was formerly part of `OMERO.webtagging <https://github.com/German-BioImaging/webtagging>`_, the umbrella name for tools developed to enhance use of text annotations (tags) in OMERO.

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

As Python 2 has now reached end-of-life, OMERO 5.6 now
requires Python 3. With release 3.1.0 of tagsearch, the following are now required. To use tagsearch on older OMERO systems (running Python 2),
please use versions older than 3.1.0.

* Python 3.8 or later
* omero-web 5.6 or later
* django 4.2 or later

User Documentation
==================

http://help.openmicroscopy.org/web-tagging.html


Installation
============

The recommended way to install tagsearch is using `pip`, but it is also possible
to install it manually as described `here <https://www.openmicroscopy.org/site/support/omero5/developers/Web/CreateApp.html#add-your-app-location-to-your-pythonpath>`_.

::

  # In the python environment of OMERO.web (virtualenv or global)
  pip install omero-tagsearch

  # Add tagsearch to webclient
  omero config append omero.web.apps '"omero_tagsearch"'

  # Add a top-link to tagsearch designer
  omero config append omero.web.ui.top_links '["Tag Search", "tagsearch"]'

Upgrade from omero-webtagging-tagsearch to omero-tagsearch
==========================================================

Since 3.2.2, the package was renamed to `omero-tagsearch`. This is a breaking change for OMERO.web, as the old package must be removed from the OMERO.web config and replaced by the new package.

You can perform the upgrade as follow:

::

  # stop omero web
  # Install the new package and uninstall the old one
  pip uninstall omero-webtagging-tagsearch  
  pip install omero-tagsearch

  # Then open the OMERO.web configuration editor
  omero config edit
  # Update the configuration called 'omero.web.apps'
  # In 'omero.web.apps': 'omero_webtagging_tagsearch' -> 'omero_tagsearch'
  # start omero web

Note that installing the latest `omero-webtagging-autotag` is not functional but has a dependency on `omero-autotag`. 
Thus, if you wish to use the old version `omero-webtagging-tagsearch`, make sure to specify the latest working version:

::

  # ONLY IF YOU WANT TO USE AN OLDER VERSION OF THE PLUGIN
  # stop omero web
  pip install omero-webtagging-tagsearch==3.2.0
  # And set the configuration accordingly
  # start omero web


Documentation
=============

Available on the `OMERO website <http://help.openmicroscopy.org/web-tagging.html>`_.


Development
===========

Pure javascript so does not require a node build step.

To install using pip in development mode (in appropriate virtualenv)

::
  # In the top-level tagsearch directory containing setup.py
  pip install -e .
  cd $OMERO_PREFIX

OMERO development server can then be started in the usual way. Remember to
configure the tagsearch settings the same as above.

Project Maintenance
===================

I (Douglas) am no longer actively developing
OMERO.webtagging. I am thrilled to hand over
maintainence and development to
`German Bioimaging <https://gerbi-gmb.de/i3dbio/i3dbio-about/>`_.

Acknowledgements
================

OMERO.webtagging was created by Douglas P. W. Russell
(dpwrussell@gmail.com) while at Oxford University and
Harvard Medical School, then later extended by DPWR
Consulting Ltd.

These plugins were developed originally with the
support of `Micron Advanced Bioimaging Unit <https://micronoxford.com/>`_
funded by the Wellcome Trust Strategic Award 091911,
and `Open Microscopy <https://www.openmicroscopy.org/>`_.

Continued development was supported by `The Laboratory
of Systems Pharmacology, Harvard Medical School <https://hits.harvard.edu/the-program/laboratory-of-systems-pharmacology/research-program/>`_ and
`Research Computing, Harvard Medical School <https://it.hms.harvard.edu/our-services/research-computing>`_.

Continued development was sponsored by
`Micron Advanced Bioimaging Unit <https://micronoxford.com/>`_
funded by the Wellcome Trust Strategic Award 107457.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/German-BioImaging/omero-tagsearch",
    "name": "omero-tagsearch",
    "maintainer": "Tom Boissonnet",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "tom.boissonnet@hhu.de",
    "keywords": "OMERO.web, webtagging, tagsearch",
    "author": "D.P.W. Russell",
    "author_email": "dpwrussell@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e9/c4/1d12399317a18ebc6b72a768bf41ed960933403ae27bb9603798d4a60180/omero-tagsearch-4.2.0.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/German-BioImaging/omero-tagsearch/workflows/PyPI/badge.svg\n   :target: https://github.com/German-BioImaging/omero-tagsearch/actions\n\n.. image:: https://badge.fury.io/py/omero-tagsearch.svg\n    :target: https://badge.fury.io/py/omero-tagsearch\n\n\nOMERO.tagsearch\n===============\nOMERO.tagsearch is a plugin for `OMERO.web <https://github.com/ome/omero-web>`_ that enables searching of data using tags, with the search continuously refined as available search terms are entered and further term suggestions based on the entered terms are offered. \nThis can be used in a way that is similar to navigating a file system hierarchy.\n\nThis was formerly part of `OMERO.webtagging <https://github.com/German-BioImaging/webtagging>`_, the umbrella name for tools developed to enhance use of text annotations (tags) in OMERO.\n\nRequirements\n============\n\nAs Python 2 has now reached end-of-life, OMERO 5.6 now\nrequires Python 3. With release 3.1.0 of tagsearch, the following are now required. To use tagsearch on older OMERO systems (running Python 2),\nplease use versions older than 3.1.0.\n\n* Python 3.8 or later\n* omero-web 5.6 or later\n* django 4.2 or later\n\nUser Documentation\n==================\n\nhttp://help.openmicroscopy.org/web-tagging.html\n\n\nInstallation\n============\n\nThe recommended way to install tagsearch is using `pip`, but it is also possible\nto install it manually as described `here <https://www.openmicroscopy.org/site/support/omero5/developers/Web/CreateApp.html#add-your-app-location-to-your-pythonpath>`_.\n\n::\n\n  # In the python environment of OMERO.web (virtualenv or global)\n  pip install omero-tagsearch\n\n  # Add tagsearch to webclient\n  omero config append omero.web.apps '\"omero_tagsearch\"'\n\n  # Add a top-link to tagsearch designer\n  omero config append omero.web.ui.top_links '[\"Tag Search\", \"tagsearch\"]'\n\nUpgrade from omero-webtagging-tagsearch to omero-tagsearch\n==========================================================\n\nSince 3.2.2, the package was renamed to `omero-tagsearch`. This is a breaking change for OMERO.web, as the old package must be removed from the OMERO.web config and replaced by the new package.\n\nYou can perform the upgrade as follow:\n\n::\n\n  # stop omero web\n  # Install the new package and uninstall the old one\n  pip uninstall omero-webtagging-tagsearch  \n  pip install omero-tagsearch\n\n  # Then open the OMERO.web configuration editor\n  omero config edit\n  # Update the configuration called 'omero.web.apps'\n  # In 'omero.web.apps': 'omero_webtagging_tagsearch' -> 'omero_tagsearch'\n  # start omero web\n\nNote that installing the latest `omero-webtagging-autotag` is not functional but has a dependency on `omero-autotag`. \nThus, if you wish to use the old version `omero-webtagging-tagsearch`, make sure to specify the latest working version:\n\n::\n\n  # ONLY IF YOU WANT TO USE AN OLDER VERSION OF THE PLUGIN\n  # stop omero web\n  pip install omero-webtagging-tagsearch==3.2.0\n  # And set the configuration accordingly\n  # start omero web\n\n\nDocumentation\n=============\n\nAvailable on the `OMERO website <http://help.openmicroscopy.org/web-tagging.html>`_.\n\n\nDevelopment\n===========\n\nPure javascript so does not require a node build step.\n\nTo install using pip in development mode (in appropriate virtualenv)\n\n::\n  # In the top-level tagsearch directory containing setup.py\n  pip install -e .\n  cd $OMERO_PREFIX\n\nOMERO development server can then be started in the usual way. Remember to\nconfigure the tagsearch settings the same as above.\n\nProject Maintenance\n===================\n\nI (Douglas) am no longer actively developing\nOMERO.webtagging. I am thrilled to hand over\nmaintainence and development to\n`German Bioimaging <https://gerbi-gmb.de/i3dbio/i3dbio-about/>`_.\n\nAcknowledgements\n================\n\nOMERO.webtagging was created by Douglas P. W. Russell\n(dpwrussell@gmail.com) while at Oxford University and\nHarvard Medical School, then later extended by DPWR\nConsulting Ltd.\n\nThese plugins were developed originally with the\nsupport of `Micron Advanced Bioimaging Unit <https://micronoxford.com/>`_\nfunded by the Wellcome Trust Strategic Award 091911,\nand `Open Microscopy <https://www.openmicroscopy.org/>`_.\n\nContinued development was supported by `The Laboratory\nof Systems Pharmacology, Harvard Medical School <https://hits.harvard.edu/the-program/laboratory-of-systems-pharmacology/research-program/>`_ and\n`Research Computing, Harvard Medical School <https://it.hms.harvard.edu/our-services/research-computing>`_.\n\nContinued development was sponsored by\n`Micron Advanced Bioimaging Unit <https://micronoxford.com/>`_\nfunded by the Wellcome Trust Strategic Award 107457.\n\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "OMERO webtagging tagsearch app",
    "version": "4.2.0",
    "project_urls": {
        "Download": "https://github.com/German-BioImaging/omero-tagsearch/archive/v4.2.0.tar.gz",
        "Homepage": "https://github.com/German-BioImaging/omero-tagsearch"
    },
    "split_keywords": [
        "omero.web",
        " webtagging",
        " tagsearch"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d627e1933d6287994a741a5339d48b0149e0a576252e750451dc478dceac3478",
                "md5": "e352a5aed14dbd9b9ff51703f1829bc3",
                "sha256": "ffef26b07d397912a3522458882758d867698da619091e4fa26e50c071055ebf"
            },
            "downloads": -1,
            "filename": "omero_tagsearch-4.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e352a5aed14dbd9b9ff51703f1829bc3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 131954,
            "upload_time": "2024-06-02T13:14:39",
            "upload_time_iso_8601": "2024-06-02T13:14:39.428241Z",
            "url": "https://files.pythonhosted.org/packages/d6/27/e1933d6287994a741a5339d48b0149e0a576252e750451dc478dceac3478/omero_tagsearch-4.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e9c41d12399317a18ebc6b72a768bf41ed960933403ae27bb9603798d4a60180",
                "md5": "2d0bab7e86f85314ee816b1e463a4ecb",
                "sha256": "5a49c48ae4a4df1510ae446034dbc32425108e4c1b8de32ac6d1157224e90eab"
            },
            "downloads": -1,
            "filename": "omero-tagsearch-4.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2d0bab7e86f85314ee816b1e463a4ecb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 122660,
            "upload_time": "2024-06-02T13:14:41",
            "upload_time_iso_8601": "2024-06-02T13:14:41.111902Z",
            "url": "https://files.pythonhosted.org/packages/e9/c4/1d12399317a18ebc6b72a768bf41ed960933403ae27bb9603798d4a60180/omero-tagsearch-4.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-02 13:14:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "German-BioImaging",
    "github_project": "omero-tagsearch",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "omero-tagsearch"
}
        
Elapsed time: 0.27482s