Metadata-Version: 2.4
Name: omero_marshal
Version: 0.9.1.dev0
Summary: OMERO Marshal
Home-page: https://github.com/ome/omero-marshal
Author: The Open Microscopy Team, Glencoe Software, Inc.
Author-email: ome-devel@lists.openmicroscopy.org.uk
License: GPLv2+
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3
License-File: LICENSE.txt
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-python
Dynamic: summary

.. image:: https://github.com/ome/omero-marshal/workflows/Tox/badge.svg
    :target: https://github.com/ome/omero-marshal/actions

.. image:: https://img.shields.io/pypi/v/omero-marshal.svg
   :alt: PyPI
   :target: https://pypi.org/project/omero-marshal/

OMERO Marshal
=============

Extensible marshaling code to transform various OMERO objects into
dictionaries which can then be marshalled using JSON or alternative
encodings.

Requirements
============

* OMERO.py 5.6 or newer
* Python 3.6 or newer

Development Installation
========================

1. Clone the repository::

        git clone git@github.com:ome/omero-marshal.git
        cd omero-marshal

2. For development, create a virtual environment and install the dependencies::

        python3 -m venv omero-marshal-venv
        source omero-marshal-venv/bin/activate
        pip install -r requirements-dev.txt
        pip install -e .

Running Tests
=============

Using py.test to run the unit tests::

    	pytest tests/unit/


You may also use tox: 

        tox

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.

Reference
=========

* https://www.openmicroscopy.org/Schemas/Documentation/Generated/OME-2015-01/ome.html
* https://docs.openmicroscopy.org/latest/omero/developers/Model/Units.html
* https://docs.openmicroscopy.org/latest/omero/developers/Model/KeyValuePairs.html
