Skip to main content

bioimageflow-omero-tools

Basic dataset download and image upload for BioImageFlow, requiring only bioimageflow-core>=0.6.0,<0.7 for discovery.

  • bioimageflow_omero_tools.omero.OmeroDownloadDataset: download every image in a dataset to an owned OME-TIFF and report image/dataset IDs, original name, complete TCZYX shape and dtype.
  • bioimageflow_omero_tools.omero.OmeroUploadImage: upload one TIFF/OME-TIFF or grayscale/RGB(A) PNG to an existing dataset, with optional image name, description and simple string metadata; return image/dataset/annotation IDs.

Both tools require explicit host, username, dataset_id and port (default 4064). Upload additionally requires image; image_name, description and metadata default to None. Store the password in the worker-accessible OS keyring using service bioimageflow-omero and key {host}:{port}:{username}. The BioImageFlow platform Settings page uses the same keyring contract and can create a node with the saved non-secret connection fields. The scientific worker does not import the platform server. Never put a password in a graph parameter, metadata, script, workflow artifact or log.

Pixel fidelity and limits

All Z, C and T planes are preserved, with returned/downloaded axes ordered TCZYX. Supported scalar dtypes are int8, uint8, int16, uint16, int32, uint32, float32 and float64. TIFF input must contain exactly one unambiguous scalar series whose axes are a subset of TCZYX ending in YX. Unlabelled higher-dimensional axes and interleaved TIFF sample axes are refused rather than guessed. PNG supports grayscale uint8/uint16 and RGB/RGBA uint8, with color and alpha samples preserved as separate OMERO channels. Palette images, transparency keys, animations, unsupported dtypes and ambiguous layouts are refused before a remote session is opened. This transfers pixel values, dimensions and dtype, not acquisition metadata, physical units, channel names, color interpretation or original source bytes. There is no Java/Bio-Formats importer or fileset support.

Execution and credentials

The declared worker recipe uses CPython 3.12, OMERO.py 5.23.0, Ice 3.6.5 and pinned NumPy, Pillow, tifffile and keyring dependencies. Official Ice wheels are selected for macOS arm64/x86_64 or glibc Linux x86_64 (glibc >=2.28). Other platforms are refused explicitly. Recipe selection occurs at package import, so package discovery itself is also limited to those supported hosts. The OS keyring backend must actually be available inside the managed worker; package discovery alone cannot establish that. Each invocation closes its own session and suppresses credential/session-bearing SDK logs while that session is active. Ice connection and call bounds are 30 and 60 seconds respectively; these are per transport call, not a total transfer deadline.

Normal caching reuses previous download snapshots or uploaded object IDs. Use the normal Force/Refresh execution controls to refresh a snapshot or intentionally create another remote image. An ordinary cached Run does not upload again. Remote uploads are not transactional: failure before the SDK returns an object ID can leave an incomplete object. Rollback attempts only the exact image/annotation IDs returned by this invocation and never deletes by name or touches arbitrary existing objects. Rollback diagnostics retain those owned kind/ID pairs and explicitly report deletion as unverified, because the SDK's finite wait can return before completion. Download paths contain numeric IDs, not remote image names, and existing paths are never replaced.

Validation

Focused package tests use synthetic arrays and fake OMERO services to check complete plane ordering, PNG values/channels, dtype preservation, schema, refusal, cleanup and secret-safe session behavior. They do not claim actual managed-worker provisioning, OS keyring access or live-server transfer. Live validation should create a uniquely owned dataset, upload and download known multi-Z/C/T pixels and basic PNG channels, compare all values and returned IDs, then clean only the recorded owned objects.

The package documentation describes the supported tool contract.

Metadata

Release files for bioimageflow-omero-tools 0.2.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 bioimageflow-omero-tools 0.2.0
File Size Uploaded Provenance Actions
bioimageflow_omero_tools-0.2.0.tar.gz 15.2 kB Without provenance Details for bioimageflow_omero_tools-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bioimageflow-omero-tools 0.2.0
File Interpreter ABI Platform Actions
bioimageflow_omero_tools-0.2.0-py3-none-any.whl Python 3 none any Details for bioimageflow_omero_tools-0.2.0-py3-none-any.whl

Total release size: 27.2 kB

Release files / bioimageflow_omero_tools-0.2.0.tar.gz

Download URL bioimageflow_omero_tools-0.2.0.tar.gz
Size 15.2 kB
Tags Source
SHA-256 checksum
How to use checksums
a5d5a59236e804c57ad344defd3099c7cd9ff73bf3df869006dc23e648a03762
BLAKE2b-256 checksum
How to use checksums
08c138b86d082e7d08bcf58d26a39a58fabb8489dc2da1afe940024901cfd717
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / bioimageflow_omero_tools-0.2.0-py3-none-any.whl

Download URL bioimageflow_omero_tools-0.2.0-py3-none-any.whl
Size 12.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
833b28607a5d7143c23524c7060a3c4cffa53fbc09fe4526f6f0eb18f608d9bb
BLAKE2b-256 checksum
How to use checksums
36c1e92d59f4f1dff5d769c3feaf47cdeaac30e39507a9a798b931ca0b27c544
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for bioimageflow-omero-tools 0.2.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

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