Package: omero-web
IntroductionOMERO.web provides a web based client and plugin infrastructure.DependenciesDirect dependencies of OMERO.web are:OMERO.pyZeroC IcePyPillowNumPyA WSGI capable web serverInstallationWe recommend installing omero-web in a Python virtual environment.
Here we show the install usingConda. For more details and
other options, please seeOMERO.py.conda create -n myenv -c ome python=3.8 zeroc-ice36-python
conda activate myenv
conda install -c conda-forge omero-py
pip install omero-webSetting of the environment variableOMERODIRis required.$OMERODIR/var/log/directory will contain log files.$OMERODIR/etc/grid/config.xmlis used to store config:export OMERODIR=$(pwd)UsageFor running omero-web in production with nginx, see See:OMERO.web installdocumentation.
To run in development mode, see below.ContributingSee:OMEROdocumentationDeveloper installationFor 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/UpgradingPlugin developers should review theUpgradingdocument highlighting steps that may need to be taken
when upgrading OMERO.web to ensure plugins or other customizations
continue to function as expected.Running testsUnit tests are located under thetestdirectory and can be run with pytest.Integration testsIntegration tests are stored in the main repository (ome/openmicroscopy) and depend on the
OMERO integration testing framework. Reading aboutRunning and writing testsin theOMEROdocumentation
is essential.Release processThis repository usesbump2versionto manage version numbers.
To tag a release run:$ bumpversion releaseThis will remove the.dev0suffix from the current version, commit, and tag the release.To switch back to a development version run:$ bumpversion --no-tag patchNB: this assumes next release will be apatch(see below).
To complete the release, push the master branch and the release tag to origin:$ git push origin master v5.8.0If any PRs are merged that would require the next release to be amajororminorversion
(seesemver.org) then that PR can include a version bump created via:$ bumpversion --no-tag minor|majorIf 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 releaseomero-web-dockerFollowingomero-webrelease, need to update and releaseomero-web-docker.LicenseOMERO.web is released under the AGPL.Copyright2009-2022, The Open Microscopy Environment, Glencoe Software, Inc.