.. image:: https://github.com/ome/omero-scripts/workflows/OMERO/badge.svg
:target: https://github.com/ome/omero-scripts/actions
.. image:: https://readthedocs.org/projects/omero-scripts/badge/?version=stable
:target: https://readthedocs.org/projects/omero-scripts/badge/?version=stable
.. image:: https://badge.fury.io/py/omero-scripts.svg
:target: https://badge.fury.io/py/omero-scripts
OMERO Core Scripts
==================
This directory contains OMERO scripts which use the
OMERO.scripts API. All scripts (e.g. ``*.py``) present in the
directory will be automatically distributed with all binary
builds. Which file-endings will be detected and how they
will be launched are both configured centrally in the server.
``.py``, ``.jy``, and ``.m`` (MATLAB) files should all be detected
by default starting with OMERO 5.
Categories
==========
Scripts are separated into several categories, one per directory.
+------------------------+-------------------------------------------------------------------------------+
| Directory | Description |
+========================+===============================================================================+
| **analysis_scripts** | crunch images to produce numerical results and similar tasks |
+------------------------+-------------------------------------------------------------------------------+
| **export_scripts** | take one or more images as an input, and produce a representation for exchange|
+------------------------+-------------------------------------------------------------------------------+
| **figure_scripts** | take one or more images as an input, and produce a summary representation |
+------------------------+-------------------------------------------------------------------------------+
| **import_scripts** | are run on images after import for extra processing |
+------------------------+-------------------------------------------------------------------------------+
| **util_scripts** | perform other miscellaneous tasks like cleaning up or optimizing OMERO itself |
+------------------------+-------------------------------------------------------------------------------+
Scripts which would like to rely on other scripts can
use::
import omero.<sub_dir>.<script_name>
For this to work, the official script in question must
be properly importable, i.e.::
def run():
client = omero.scripts.client(...)
if __name__ == "__main__":
run()
OMERO User Scripts
==================
If you would like to provide your own scripts for others to install
into their OMERO installations, please see https://openmicroscopy.org/info/scripts
Testing
=======
Integration tests under ``test/`` require an OMERO server with scripts installed.
The tests are run by Travis for open PRs using omero-test-infra to deploy OMERO
via Docker containers.
To run tests locally::
# All tests
$ python setup.py test
# Single test in a single file
$ python setup.py test -t test/integration/test_util_scripts.py -k test_dataset_to_plate
Usage
=====
See https://omero-scripts.readthedocs.io/en/stable/
Release process
===============
This repository uses `bump2version <https://pypi.org/project/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 <https://semver.org/>`_. 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.
Copyright
=========
2010-2024, The Open Microscopy Environment
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/omero-scripts/",
"name": "omero-scripts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": null,
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/6f/cf/6b2d4dd31a930cc7cb938011a24588530f38be648009e88cc930240705dd/omero_scripts-5.8.3.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/ome/omero-scripts/workflows/OMERO/badge.svg\n :target: https://github.com/ome/omero-scripts/actions\n\n.. image:: https://readthedocs.org/projects/omero-scripts/badge/?version=stable\n :target: https://readthedocs.org/projects/omero-scripts/badge/?version=stable\n\n.. image:: https://badge.fury.io/py/omero-scripts.svg\n :target: https://badge.fury.io/py/omero-scripts\n\nOMERO Core Scripts\n==================\n\nThis directory contains OMERO scripts which use the\nOMERO.scripts API. All scripts (e.g. ``*.py``) present in the\ndirectory will be automatically distributed with all binary\nbuilds. Which file-endings will be detected and how they\nwill be launched are both configured centrally in the server.\n``.py``, ``.jy``, and ``.m`` (MATLAB) files should all be detected\nby default starting with OMERO 5.\n\n\nCategories\n==========\n\nScripts are separated into several categories, one per directory.\n\n+------------------------+-------------------------------------------------------------------------------+\n| Directory | Description |\n+========================+===============================================================================+ \n| **analysis_scripts** | crunch images to produce numerical results and similar tasks |\n+------------------------+-------------------------------------------------------------------------------+\n| **export_scripts** | take one or more images as an input, and produce a representation for exchange|\n+------------------------+-------------------------------------------------------------------------------+\n| **figure_scripts** | take one or more images as an input, and produce a summary representation |\n+------------------------+-------------------------------------------------------------------------------+\n| **import_scripts** | are run on images after import for extra processing |\n+------------------------+-------------------------------------------------------------------------------+\n| **util_scripts** | perform other miscellaneous tasks like cleaning up or optimizing OMERO itself |\n+------------------------+-------------------------------------------------------------------------------+\n\n\nScripts which would like to rely on other scripts can\nuse::\n\n import omero.<sub_dir>.<script_name>\n\nFor this to work, the official script in question must\nbe properly importable, i.e.::\n\n def run():\n client = omero.scripts.client(...)\n\n if __name__ == \"__main__\":\n run()\n\n\nOMERO User Scripts\n==================\n\nIf you would like to provide your own scripts for others to install\ninto their OMERO installations, please see https://openmicroscopy.org/info/scripts\n\n\nTesting\n=======\n\nIntegration tests under ``test/`` require an OMERO server with scripts installed.\nThe tests are run by Travis for open PRs using omero-test-infra to deploy OMERO\nvia Docker containers.\n\nTo run tests locally::\n\n\t# All tests\n\t$ python setup.py test\n\n\t# Single test in a single file\n\t$ python setup.py test -t test/integration/test_util_scripts.py -k test_dataset_to_plate\n\nUsage\n=====\n\nSee https://omero-scripts.readthedocs.io/en/stable/\n\nRelease process\n===============\n\nThis repository uses `bump2version <https://pypi.org/project/bump2version/>`_ to manage version numbers.\nTo tag a release run::\n\n $ bumpversion release\n\nThis will remove the ``.dev0`` suffix from the current version, commit, and tag the release.\n\nTo switch back to a development version run::\n\n $ bumpversion --no-tag [major|minor|patch]\n\nspecifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.\n\nRemember to ``git push`` all commits and tags.s essential.\n\nThe CI pipeline will automatically deploy the tag onto PyPI.\n\n\nCopyright\n=========\n\n2010-2024, The Open Microscopy Environment\n",
"bugtrack_url": null,
"license": "GPL-2.0+",
"summary": "OMERO scripts",
"version": "5.8.3",
"project_urls": {
"Download": "https://github.com/ome/omero-scripts/",
"Homepage": "https://github.com/ome/omero-scripts/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc25dd6942ae44fb66f2229cceec8911f9999c52c24646302eeac32b5164bd5e",
"md5": "f92193624b0a2bc04c61a92af140f0d8",
"sha256": "92acbf76e313c35baf84681a89df4b787461b2b7a9bc85dc3c69df987a8b2255"
},
"downloads": -1,
"filename": "omero_scripts-5.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f92193624b0a2bc04c61a92af140f0d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 116507,
"upload_time": "2024-07-25T14:50:04",
"upload_time_iso_8601": "2024-07-25T14:50:04.260783Z",
"url": "https://files.pythonhosted.org/packages/bc/25/dd6942ae44fb66f2229cceec8911f9999c52c24646302eeac32b5164bd5e/omero_scripts-5.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6fcf6b2d4dd31a930cc7cb938011a24588530f38be648009e88cc930240705dd",
"md5": "0925efed922eb0980f9eb9a937b8f686",
"sha256": "255662efb361eb369c153e9871d33dcee14a02dc8ea7ae980d7dada5baccf011"
},
"downloads": -1,
"filename": "omero_scripts-5.8.3.tar.gz",
"has_sig": false,
"md5_digest": "0925efed922eb0980f9eb9a937b8f686",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 86435,
"upload_time": "2024-07-25T14:50:06",
"upload_time_iso_8601": "2024-07-25T14:50:06.038378Z",
"url": "https://files.pythonhosted.org/packages/6f/cf/6b2d4dd31a930cc7cb938011a24588530f38be648009e88cc930240705dd/omero_scripts-5.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 14:50:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "omero-scripts",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "omero-scripts"
}
JSON
