Skip to main content

OMERO.web

Project description

https://github.com/ome/omero-web/workflows/Tox/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg https://badge.fury.io/py/omero-web.svg

Introduction

OMERO.web provides a web based client and plugin infrastructure.

Dependencies

Direct dependencies of OMERO.web are:

Installation

We recommend installing omero-web in a Python virtual environment. Here we show the install using Conda. For more details and other options, please see OMERO.py.

conda create -n myenv -c ome python=3.6 zeroc-ice36-python omero-py conda activate myenv pip install 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/

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 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) 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omero-web-5.9.0.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

omero_web-5.9.0-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file omero-web-5.9.0.tar.gz.

File metadata

  • Download URL: omero-web-5.9.0.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for omero-web-5.9.0.tar.gz
Algorithm Hash digest
SHA256 bf67cf4dd607ab33ff0705778e0381d3f00f1827e308f378d98040e237694ae0
MD5 4577e3be597f6b6b44191c25df267365
BLAKE2b-256 ebcfc85175029db4d5e84ea189c88bdd3a36cbfc16e6f3e587aedb5151ff1f3b

See more details on using hashes here.

Provenance

File details

Details for the file omero_web-5.9.0-py3-none-any.whl.

File metadata

  • Download URL: omero_web-5.9.0-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for omero_web-5.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32fb7cfbe2796ddac6c7139b3e5203e3652c3332af03c88b1c69530841c65ee8
MD5 159c42d6f4c7ee7bd25f266f5042a8dd
BLAKE2b-256 77cce9cedd62b9bbb4d82331014047005f605bd1a9bc06ec93c77bec8922d566

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page