Skip to main content

Python bindings to the OMERO.blitz server

Project description

https://github.com/ome/omero-py/workflows/Build/badge.svg https://badge.fury.io/py/omero-py.svg

Introduction

OMERO.py provides Python bindings to the OMERO.blitz server as well as a pluggable command-line interface.

Dependencies

Direct dependencies of OMERO.py are:

Installation

We recommend installing omero-py in a Python virtual environment. You can create one using for example venv, conda or mamba.

Before installing omero-py, we recommend to install the ZeroC IcePy 3.6 Python bindings. Our commercial partner Glencoe Software has produced several Python wheels to install the Ice-Python bindings depending on the desired Python version and the operating system. Please visit OMERO.py for a list of supported platforms and Python versions.

When the wheel is installed, activate the virtual environment and install omero-py from PyPI:

$ pip install -U omero-py

Setting of the environment variable OMERODIR is required for some functionality. $OMERODIR/var/log/ directory will contain log files. $OMERODIR/etc/grid/config.xml is used to store config.

If OMERODIR is set to an OMERO.server directory, the import and admin commands will be enabled:

# If you need import or admin commands:
export OMERODIR=/path/to/OMERO.server/

# otherwise, can choose any location.
export OMERODIR=$(pwd)

Since version 5.13.0, the use of omero certificates is required to ensure that an OMERO server installation has, at minimum, a self-signed certificate.

See: OMERO documentation for more details and OMERO server certificate management plugin

Usage

Contributing

See: OMERO documentation

Developer installation

OMERO.py currently depends on an externally built artifact which is automatically bundled in the PyPI package.

For a development installation, we recommend to create a virtual environment with the Ice-Python binding matching your Python version and your operating system, see OMERO.py.

Activate the virtual environment and clone this repository:

$ git clone https://github.com/ome/omero-py
$ cd omero-py
$ python setup.py devtarget
$ pip install -e .

This will install omero-py into your virtualenv as an editable package, so any edits to src files should be reflected in your installation. Note that if you add or remove files you must rerun the last two steps.

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

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 [major|minor|patch]

specifying major, minor or patch depending on whether the development branch will be a major, minor or patch release. This will also add the .dev0 suffix.

Remember to git push all commits and tags.s essential.

The CI pipeline will automatically deploy the tag onto PyPI. Once released, a Pull Request will be automatically opened against conda-omero-py to update the official OMERO.py Conda package.

Documentation

The API documentation is generated using Sphinx. To generate it:

  • Install Sphinx.

  • Set the environment variable NO_TEMP_MANAGER to true.

  • In the docs directory, run make clean html.

License

OMERO.py is released under the GPL v2.

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_py-5.19.3.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

omero_py-5.19.3-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file omero_py-5.19.3.tar.gz.

File metadata

  • Download URL: omero_py-5.19.3.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for omero_py-5.19.3.tar.gz
Algorithm Hash digest
SHA256 974e835fa2e26def25c6cdac4440db721fe9ac24f6df1da3f1d6af96d89d288d
MD5 873e2bad4e95caf14607d46b8b527b6e
BLAKE2b-256 55bbe845415f118aa45d0b53c741b71960cbbe07696608f8de1905af24b06602

See more details on using hashes here.

File details

Details for the file omero_py-5.19.3-py3-none-any.whl.

File metadata

  • Download URL: omero_py-5.19.3-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for omero_py-5.19.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0e6f31d51caaf17d0fcca164078efd9380976eaf0fbebcbb25312da1978e40cb
MD5 0e5bdd52837ecc56328de8bd366d091e
BLAKE2b-256 8952a20a8f9e0ef70e524b3e1c0adb8e88596a1c5a08e2672af0992c31f3edd6

See more details on using hashes here.

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