OMERO.web
=========
.. image:: https://github.com/ome/omero-web/workflows/Tox/badge.svg
:target: https://github.com/ome/omero-web/actions
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. image:: https://badge.fury.io/py/omero-web.svg
:target: https://badge.fury.io/py/omero-web
Introduction
------------
OMERO.web provides a web based client and plugin infrastructure.
Dependencies
------------
Direct dependencies of OMERO.web are:
- `OMERO.py`_
- `ZeroC IcePy`_
- `Pillow`_
- `NumPy`_
- A WSGI capable web server
Installation
------------
We recommend installing ``omero-web`` in a Python virtual environment.
Before installing ``omero-web``, we recommend to install the `ZeroC IcePy`_ Python bindings.
Our commercial partner `Glencoe Software <https://www.glencoesoftware.com/blog/2023/12/08/ice-binaries-for-omero.html>`_ 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 <https://omero.readthedocs.io/en/stable/developers/Python.html>`_ for a list of supported platforms and Python versions.
When the wheel is installed, activate the virtual environment and install ``omero-web`` from `PyPI <https://pypi.org/>`_.
::
$ pip install -U omero-web
Setting of the environment variable ``OMERODIR`` is required.
``$OMERODIR/var/log/`` directory will contain log files.
``$OMERODIR/etc/grid/config.xml`` is used to store config::
$ export OMERODIR=$(pwd)
Usage
-----
For running omero-web in production with NGINX, see See: `OMERO.web install`_ documentation.
To run in development mode, see below.
Contributing
------------
See: `OMERO`_ documentation
Developer installation
----------------------
For a development installation we recommend creating a virtual environment as described above.
Then install OMERO.web into your virtual environment as an editable package, so that any edits
to source files will be reflected in your installation.
::
$ git clone https://github.com/ome/omero-web
$ cd omero-web
$ pip install -e .
Note some ``omero-web`` tests may not run when this module and/or ``omero-py`` are installed in editable mode.
Configuration for developer usage::
$ omero config set omero.web.debug True
$ omero config set omero.web.application_server development
# If you want to connect to OMERO.server other than 'localhost'
$ omero config append omero.web.server_list '["demo.openmicroscopy.org", 4064, "demo"]'
Then run omero-web in the foreground with::
$ omero web start
...
Starting development server at http://127.0.0.1:4080/
Or, run Django directly::
$ cd omero-web
$ python omeroweb/manage.py runserver 4080
...
Starting development server at http://127.0.0.1:4080/
Upgrading
---------
Plugin developers should review the `Upgrading <UPGRADING.md>`_
document highlighting steps that may need to be taken
when upgrading OMERO.web to ensure plugins or other customizations
continue to function as expected.
Running tests
-------------
Unit tests are located under the `test` directory and can be run with pytest.
Integration tests
^^^^^^^^^^^^^^^^^
Integration tests are stored in the main repository (ome/openmicroscopy) and depend on the
OMERO integration testing framework. Reading about `Running and writing tests`_ in the `OMERO`_ documentation
is essential.
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 patch
NB: this assumes next release will be a ``patch`` (see below).
To complete the release, push the master branch and the release tag to origin::
$ git push origin master v5.8.0
If any PRs are merged that would require the next release to be a ``major`` or ``minor`` version
(see `semver.org <https://semver.org/>`_) then that PR can include a version bump created via::
$ bumpversion --no-tag minor|major
If this hasn't been performed prior to release and you wish to specify the next version
number directly when creating the release, this can be achieved with::
$ bumpversion --new-version 5.9.0 release
omero-web-docker
^^^^^^^^^^^^^^^^
Following ``omero-web`` release, need to update and release ``omero-web-docker``.
License
-------
OMERO.web is released under the AGPL.
Copyright
---------
2009-2024, The Open Microscopy Environment, Glencoe Software, Inc.
.. _OMERO: https://www.openmicroscopy.org/omero
.. _OMERO.web install: https://omero.readthedocs.io/en/stable/sysadmins/unix/install-web/web-deployment.html
.. _OMERO.py: https://pypi.python.org/pypi/omero-py
.. _ZeroC IcePy: https://zeroc.com/downloads/ice/3.6
.. _Pillow: https://python-pillow.org/
.. _NumPy: http://matplotlib.org/
.. _Running and writing tests: https://omero.readthedocs.io/en/stable/omero/developers/testing.html
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/omero-web/",
"name": "omero-web",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/ec/a0/c7d6e059aa1ef474df96e696fdab8a6c14598ba43cd81864322cb1b1efbd/omero-web-5.28.0.tar.gz",
"platform": null,
"description": "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 <https://www.glencoesoftware.com/blog/2023/12/08/ice-binaries-for-omero.html>`_ 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 <https://omero.readthedocs.io/en/stable/developers/Python.html>`_ 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 <https://pypi.org/>`_.\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\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 <UPGRADING.md>`_\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 <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 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 <https://semver.org/>`_) 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\n\n",
"bugtrack_url": null,
"license": "GPLv2+",
"summary": "OMERO.web",
"version": "5.28.0",
"project_urls": {
"Homepage": "https://github.com/ome/omero-web/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1b2d7126bdc6571ecd6235b8e7000e60905eea58f17d1718772b9346fc4d31d",
"md5": "598c506d059b77bcbf38a655a7cffe95",
"sha256": "9be820b65dcf6945c4aaf4c3ce32da3dc5fa4be6f3c45d5dfd6da2d8be5c4c5d"
},
"downloads": -1,
"filename": "omero_web-5.28.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "598c506d059b77bcbf38a655a7cffe95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2767542,
"upload_time": "2024-11-20T13:34:43",
"upload_time_iso_8601": "2024-11-20T13:34:43.015295Z",
"url": "https://files.pythonhosted.org/packages/c1/b2/d7126bdc6571ecd6235b8e7000e60905eea58f17d1718772b9346fc4d31d/omero_web-5.28.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eca0c7d6e059aa1ef474df96e696fdab8a6c14598ba43cd81864322cb1b1efbd",
"md5": "9ec5f8be9f4a31ca279fbf8dd2172b9b",
"sha256": "b0f2b7f439bda01a1309cd2318dd8260c81df18e33c2aff6f6d3ecfd1d114593"
},
"downloads": -1,
"filename": "omero-web-5.28.0.tar.gz",
"has_sig": false,
"md5_digest": "9ec5f8be9f4a31ca279fbf8dd2172b9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2272770,
"upload_time": "2024-11-20T13:34:44",
"upload_time_iso_8601": "2024-11-20T13:34:44.815527Z",
"url": "https://files.pythonhosted.org/packages/ec/a0/c7d6e059aa1ef474df96e696fdab8a6c14598ba43cd81864322cb1b1efbd/omero-web-5.28.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 13:34:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "omero-web",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "omero-web"
}
JSON
