Skip to main content
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 either venv or conda (preferred). If you opt for Conda, you will need to install it first, see miniconda for more details.

To install omero-py using conda (preferred):

conda create -n myenv -c conda-forge python=3.8 omero-py
conda activate myenv

Alternatively install omero-py using venv:

python3.6 -m venv myenv
. myenv/bin/activate
pip install omero-py

You may need to replace python3.6 with python or python3 depending on your Python distribution.

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)

See: OMERO documentation for more details.

Usage

  • For OMERO python language bindings, see OMERO.py.

  • For Command Line usage, see OMERO.CLI.

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 creating a virtualenv with the following setup (example assumes python3.6 but you can create and activate the virtualenv using any compatible Python):

To install using venv:

python3.6 -mvenv myenv
. myenv/bin/activate
git clone https://github.com/ome/omero-py
cd omero-py
python setup.py devtarget
pip install -e .

To install omero-py using conda (preferred):

conda create -n myenv -c ome python=3.6 zeroc-ice36-python
conda activate myenv
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 needs to be opened against conda-omero-py to update the official OMERO.py Conda package.

License

OMERO.py is released under the GPL v2.

Metadata

Release files for omero-py 5.12.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for omero-py 5.12.0
File Size Uploaded Provenance Actions
omero-py-5.12.0.tar.gz 2.3 MB Without provenance Details for omero-py-5.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for omero-py 5.12.0
File Interpreter ABI Platform Actions
omero_py-5.12.0-py3-none-any.whl Python 3 none any Details for omero_py-5.12.0-py3-none-any.whl

Total release size: 5.1 MB

Release files / omero-py-5.12.0.tar.gz

Download URL omero-py-5.12.0.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
a994d672bab2ef0af054c1d64d135a85e468d3a6ea60cca64bd7e54b2becdf29
BLAKE2b-256 checksum
How to use checksums
296f5965ff750d6296f63f8d2b1ed48d758425b6b81b850f56a53654df5fae07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.13

Release files / omero_py-5.12.0-py3-none-any.whl

Download URL omero_py-5.12.0-py3-none-any.whl
Size 2.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
66e82aea8fd43267eac6333dad66217e4723d0848d920774d7fb7ed2b07118db
BLAKE2b-256 checksum
How to use checksums
52e936f076a16a3e997e365d3bc7d4ff6990da103d85aefe4ba04c0be268c0d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.13

Security for omero-py 5.12.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.12.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page