{"id":22281054,"url":"https://github.com/ome/omero-web","last_synced_at":"2025-04-04T15:10:12.180Z","repository":{"id":37752135,"uuid":"200678050","full_name":"ome/omero-web","owner":"ome","description":"Django-based OMERO.web client","archived":false,"fork":false,"pushed_at":"2024-10-08T00:01:12.000Z","size":26406,"stargazers_count":16,"open_issues_count":136,"forks_count":30,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-10-29T14:23:06.803Z","etag":null,"topics":["client","django","omero","python","web"],"latest_commit_sha":null,"homepage":"https://www.openmicroscopy.org/omero","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ome.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-05T15:05:08.000Z","updated_at":"2024-09-10T18:58:15.000Z","dependencies_parsed_at":"2022-07-08T04:54:41.401Z","dependency_job_id":"f83822a9-a3f6-474a-a674-785da5f33998","html_url":"https://github.com/ome/omero-web","commit_stats":{"total_commits":9031,"total_committers":48,"mean_commits":"188.14583333333334","dds":0.5253017384564278,"last_synced_commit":"da5b7d11f5375f024d3881db2dcc63899b4087da"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fomero-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fomero-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fomero-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ome%2Fomero-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ome","download_url":"https://codeload.github.com/ome/omero-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246613716,"owners_count":20805603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","django","omero","python","web"],"created_at":"2024-12-03T16:13:09.991Z","updated_at":"2025-04-04T15:10:12.161Z","avatar_url":"https://github.com/ome.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"OMERO.web\n=========\n.. image::  https://github.com/ome/omero-web/workflows/Tox/badge.svg\n    :target: https://github.com/ome/omero-web/actions\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n\n.. image:: https://badge.fury.io/py/omero-web.svg\n    :target: https://badge.fury.io/py/omero-web\n\nIntroduction\n------------\n\nOMERO.web provides a web based client and plugin infrastructure.\n\nDependencies\n------------\n\nDirect dependencies of OMERO.web are:\n\n- `OMERO.py`_\n- `ZeroC IcePy`_\n- `Pillow`_\n- `NumPy`_\n- A WSGI capable web server\n\nInstallation\n------------\n\nWe recommend installing ``omero-web`` in a Python virtual environment.\n\nBefore installing ``omero-web``, we recommend to install the `ZeroC IcePy`_ Python bindings.\nOur commercial partner `Glencoe Software \u003chttps://www.glencoesoftware.com/blog/2023/12/08/ice-binaries-for-omero.html\u003e`_ has produced several Python wheels to install the Ice-Python bindings depending on the desired Python version and the operating system. Please visit `OMERO Python language bindings \u003chttps://omero.readthedocs.io/en/stable/developers/Python.html\u003e`_ for a list of supported platforms and Python versions.\n\nWhen the wheel is installed, activate the virtual environment and install ``omero-web`` from `PyPI \u003chttps://pypi.org/\u003e`_.\n\n::\n\n    $  pip install -U omero-web\n\nSetting of the environment variable ``OMERODIR`` is required.\n``$OMERODIR/var/log/`` directory will contain log files.\n``$OMERODIR/etc/grid/config.xml`` is used to store config::\n\n    $ export OMERODIR=$(pwd)\n\nUsage\n-----\n\nFor running omero-web in production with NGINX, see See: `OMERO.web install`_ documentation.\nTo run in development mode, see below.\n\nLUTs caching\n------------\n\nThe OMERO server ships with a set of look-up tables (LUTs) for rendering images. Admins can also\nadd their own LUTs to the server. The LUTs available on the server can be retrieved from the\n``/webgateway/luts/`` endpoint as JSON data.\n\nTo include the ``rgb`` values of each LUT in the JSON response, append ``?rgb=true`` to the URL.\n\nA copy of the JSON output from ``/webgateway/luts/?rgb=true`` is included in the ``omero-web`` package\nas a static file at\nhttps://github.com/ome/omero-web/blob/master/omeroweb/webgateway/static/webgateway/json/luts.json.\n\nThis is used to generate a LUT preview png at ``/webgateway/luts_png/`` that can be used by clients\nsuch as OMERO.ivewer and OMERO.figure to display the LUTs in a user-friendly way.\nBy using the static ``luts.json``, the ``/luts_png/`` can be quickly generated without needing to load LUTs from\nthe server.\n\nThe sequence of LUTs in ``/webgateway/luts_png/`` corresponds to the dynamic list from ``/webgateway/luts/``.\nIf there are new LUTs on the server that are not found in the static ``luts.json``, the ``/luts_png/`` will\nshow a blank placeholder for that LUT.\n\nIf you have Django caching enabled on your server (e.g. with Redis) then you can cache the png *with* new\nLUTs by visiting ``/webgateway/luts_png/?cached=false``. This will then be read by other users when\nthey visit ``/webgateway/luts_png/``.\n\nIf Django caching isn't enabled, the JSON response from ``/webgateway/luts/?rgb=true``\ncan instead be manually updated in the static ``luts.json`` file in the ``omero-web`` package.\n\n\nContributing\n------------\n\nSee: `OMERO`_ documentation\n\nDeveloper installation\n----------------------\n\nFor a development installation we recommend creating a virtual environment as described above.\nThen install OMERO.web into your virtual environment as an editable package, so that any edits\nto source files will be reflected in your installation.\n\n::\n\n    $ git clone https://github.com/ome/omero-web\n    $ cd omero-web\n    $ pip install -e .\n\nNote some ``omero-web`` tests may not run when this module and/or ``omero-py`` are installed in editable mode.\n\nConfiguration for developer usage::\n\n    $ omero config set omero.web.debug True\n    $ omero config set omero.web.application_server development\n\n    # If you want to connect to OMERO.server other than 'localhost'\n    $ omero config append omero.web.server_list '[\"demo.openmicroscopy.org\", 4064, \"demo\"]'\n\nThen run omero-web in the foreground with::\n\n    $ omero web start\n    ...\n    Starting development server at http://127.0.0.1:4080/\n\nOr, run Django directly::\n\n    $ cd omero-web\n    $ python omeroweb/manage.py runserver 4080\n    ...\n    Starting development server at http://127.0.0.1:4080/\n\nUpgrading\n---------\n\nPlugin developers should review the `Upgrading \u003cUPGRADING.md\u003e`_\ndocument highlighting steps that may need to be taken\nwhen upgrading OMERO.web to ensure plugins or other customizations\ncontinue to function as expected.\n\nRunning tests\n-------------\n\nUnit tests are located under the `test` directory and can be run with pytest.\n\nIntegration tests\n^^^^^^^^^^^^^^^^^\n\nIntegration tests are stored in the main repository (ome/openmicroscopy) and depend on the\nOMERO integration testing framework. Reading about `Running and writing tests`_ in the `OMERO`_ documentation\nis essential.\n\nRelease process\n---------------\n\nThis repository uses `bump2version \u003chttps://pypi.org/project/bump2version/\u003e`_ 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 patch\n\nNB: this assumes next release will be a ``patch`` (see below).\nTo complete the release, push the master branch and the release tag to origin::\n\n    $ git push origin master v5.8.0\n\nIf any PRs are merged that would require the next release to be a ``major`` or ``minor`` version\n(see `semver.org \u003chttps://semver.org/\u003e`_) then that PR can include a version bump created via::\n\n    $ bumpversion --no-tag minor|major\n\nIf this hasn't been performed prior to release and you wish to specify the next version\nnumber directly when creating the release, this can be achieved with::\n\n    $ bumpversion --new-version 5.9.0 release\n\nomero-web-docker\n^^^^^^^^^^^^^^^^\n\nFollowing ``omero-web`` release, need to update and release ``omero-web-docker``.\n\nLicense\n-------\n\nOMERO.web is released under the AGPL.\n\nCopyright\n---------\n\n2009-2024, The Open Microscopy Environment, Glencoe Software, Inc.\n\n.. _OMERO: https://www.openmicroscopy.org/omero\n.. _OMERO.web install: https://omero.readthedocs.io/en/stable/sysadmins/unix/install-web/web-deployment.html\n.. _OMERO.py: https://pypi.python.org/pypi/omero-py\n.. _ZeroC IcePy: https://zeroc.com/downloads/ice/3.6\n.. _Pillow: https://python-pillow.org/\n.. _NumPy: http://matplotlib.org/\n.. _Running and writing tests: https://omero.readthedocs.io/en/stable/omero/developers/testing.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fome%2Fomero-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fome%2Fomero-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fome%2Fomero-web/lists"}