Skip to main content

A plugin for exporting RDF from OMERO

Project description

https://github.com/German-BioImaging/omero-rdf/workflows/OMERO/badge.svg https://badge.fury.io/py/omero-rdf.svg

omero-rdf

A plugin for exporting RDF from OMERO

Requirements

  • OMERO 5.6.0 or newer

  • Python 3.10, 3.11, or 3.12 (only versions with zeroc-ice binary wheels are supported; newer versions will be added when wheels are available)

Installing from PyPI

This section assumes that an OMERO.py is already installed and zeroc-ice is configured.

Install the command-line tool using pip:

$ pip install -U omero-rdf

Developer guidelines

Using uv (recommended):

  1. Fork/clone the repository (e.g. gh repo fork https://github.com/German-BioImaging/omero-rdf).

  2. Create a virtualenv and activate it:

    uv venv .venv
    source .venv/bin/activate

    (or prefix commands with uv run instead of activating).

  3. Install in editable mode with test dependencies:

    ::

    uv pip install -r zeroc-ice-requirements.txt uv pip install -e “.[tests,dev]”

  4. Run the test suite:

    pytest test/unit
    pytest test/integration/test_idr
  5. Lint and format:

    ruff check
    ruff format --check
    ruff format

To run pre-commit hooks:

uv tool install pre-commit
pre-commit run --all-files

Quick check against IDR

Assuming you have the uv environment active (source .venv/bin/activate), use the public IDR server to confirm the CLI works (public credentials):

  1. Log in once to create a session:

    omero login -s idr.openmicroscopy.org -u [PUBLIC USER] -w [PUBLIC PASSWORD]
  2. Export RDF for a project on IDR (2902) and inspect the first triples:

    omero rdf -F=turtle Project:2902 -S=flat | head  -n 10

Mocking GitHub Actions checks

  1. If you have gh installed, you can run the checks locally:

    gh act push

Release process

This repository uses versioneer to manage version numbers. A tag prefixed with v will be detected by the library and used as the current version at runtime.

Remember to git push all commits and tags.

Funding

Funded by the Delta Tissue Program of Wellcome Leap.

License

This project, similar to many Open Microscopy Environment (OME) projects, is licensed under the terms of the GNU General Public License (GPL) v2 or later.

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_rdf-0.7.2.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

omero_rdf-0.7.2-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file omero_rdf-0.7.2.tar.gz.

File metadata

  • Download URL: omero_rdf-0.7.2.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for omero_rdf-0.7.2.tar.gz
Algorithm Hash digest
SHA256 50813f10f4f4a0b382f7fefa5e6a531f16acc7b535ff86318559e40fbbc23430
MD5 1161593ceedf0d86ef0b50cc930b943e
BLAKE2b-256 075e1fe5f3b6f04a582dd506033aea834a81dcb7d240c5bc1d06216010c9f950

See more details on using hashes here.

File details

Details for the file omero_rdf-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: omero_rdf-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for omero_rdf-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3b890cdf1a2dd4f3085aceffdf30a2913df4f08da9c6adf9b4df8136d0382e02
MD5 83a287408e3129107a6db815bb5b3bbf
BLAKE2b-256 e6b20961be09a7841e330e9ffc93ce9247b1e34bc45d8a0f9fb4e775bbb17675

See more details on using hashes here.

Supported by

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