.. image:: https://github.com/ome/omero-cli-server/workflows/Tox/badge.svg
:target: https://github.com/ome/omero-cli-server/actions
.. image:: https://badge.fury.io/py/omero-cli-server.svg
:target: https://badge.fury.io/py/omero-cli-server
OMERO.server CLI Plugin
=======================
Introduction
------------
OMERO.py provides a plugin infrastructure for CLI tools.
Most tools are intended for the general user wanting to
login to a running OMERO.server. Other plugins like this
one are intended for the management of the installation
itself.
Dependencies
------------
Direct dependencies of this plugin are:
- `OMERO.py`_
- `ZeroC IcePy`_
Installation
------------
See: `OMERO`_ documentation
Usage
-----
See: `OMERO`_ documentation
Contributing
------------
See: `OMERO`_ documentation
Developer installation
----------------------
`omero-server `depends on OMERO.py. If you want a developer installation of OMERO.py, replace ``pip install omero-py``
with instructions at https://github.com/ome/omero-py.
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):
::
python3.6 -mvenv venv
. venv/bin/activate
pip install zeroc-ice==3.6.5
pip install omero-py # OR dev install (see above)
git clone https://github.com/ome/omero-cli-server
cd omero-server
pip install -e .
This will install the server plugins into your virtualenv as an editable
package, so any edits to source files should be reflected in your installation.
Note some tests may not run when this module and/or omero-py are installed in editable mode.
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
is essential.
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.
License
-------
omero-cli-server is released under the GPL.
Copyright
---------
2020-2022, The Open Microscopy Environment
.. _OMERO: https://www.openmicroscopy.org/omero
.. _OMERO.py: https://pypi.python.org/pypi/omero-py
.. _ZeroC IcePy: https://zeroc.com/
.. _Running and writing tests: https://docs.openmicroscopy.org/latest/omero/developers/testing.html
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/omero-cli-server/",
"name": "omero-server",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "",
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/66/f3/8165247a0acc3abdb31da96b295f0285ba86f21cedd9581e4b57f2bbd153/omero-server-0.4.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/ome/omero-cli-server/workflows/Tox/badge.svg\n :target: https://github.com/ome/omero-cli-server/actions\n\n.. image:: https://badge.fury.io/py/omero-cli-server.svg\n :target: https://badge.fury.io/py/omero-cli-server\n\nOMERO.server CLI Plugin\n=======================\n\nIntroduction\n------------\n\nOMERO.py provides a plugin infrastructure for CLI tools.\nMost tools are intended for the general user wanting to\nlogin to a running OMERO.server. Other plugins like this\none are intended for the management of the installation\nitself.\n\nDependencies\n------------\n\nDirect dependencies of this plugin are:\n\n- `OMERO.py`_\n- `ZeroC IcePy`_\n\nInstallation\n------------\n\nSee: `OMERO`_ documentation\n\nUsage\n-----\n\nSee: `OMERO`_ documentation\n\nContributing\n------------\n\nSee: `OMERO`_ documentation\n\nDeveloper installation\n----------------------\n\n`omero-server `depends on OMERO.py. If you want a developer installation of OMERO.py, replace ``pip install omero-py``\nwith instructions at https://github.com/ome/omero-py.\n\nFor 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):\n\n::\n\n python3.6 -mvenv venv\n . venv/bin/activate\n pip install zeroc-ice==3.6.5\n pip install omero-py # OR dev install (see above)\n git clone https://github.com/ome/omero-cli-server\n cd omero-server\n pip install -e .\n\nThis will install the server plugins into your virtualenv as an editable\npackage, so any edits to source files should be reflected in your installation.\n\nNote some tests may not run when this module and/or omero-py are installed in editable mode.\n\nRunning tests\n-------------\n\nUnit tests are located under the `test` directory and can be run with pytest.\n\nIntegration tests\n^^^^^^^^^^^^^^^^^\n\nIntegration tests are stored in the main repository (ome/openmicroscopy) and depend on the\nOMERO integration testing framework. Reading about `Running and writing tests`_ in the `OMERO`_ documentation\nis essential.\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.\n\nLicense\n-------\n\nomero-cli-server is released under the GPL.\n\nCopyright\n---------\n\n2020-2022, The Open Microscopy Environment\n\n.. _OMERO: https://www.openmicroscopy.org/omero\n.. _OMERO.py: https://pypi.python.org/pypi/omero-py\n.. _ZeroC IcePy: https://zeroc.com/\n.. _Running and writing tests: https://docs.openmicroscopy.org/latest/omero/developers/testing.html\n\n\n",
"bugtrack_url": null,
"license": "GPLv2+",
"summary": "CLI plugin for managing an OMERO.server",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/ome/omero-cli-server/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "909f25184129b696332dc62d9ed90ee6f0179c52b571797c3a8a6aa4f99aa89d",
"md5": "7662bc3c59fea0978797d73f86095af3",
"sha256": "ddac3094e835f5ac5c2fa17049a24d2a9844e0f5dcefd922ec5b474004ed319d"
},
"downloads": -1,
"filename": "omero_server-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7662bc3c59fea0978797d73f86095af3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 10127,
"upload_time": "2023-10-25T10:25:54",
"upload_time_iso_8601": "2023-10-25T10:25:54.996661Z",
"url": "https://files.pythonhosted.org/packages/90/9f/25184129b696332dc62d9ed90ee6f0179c52b571797c3a8a6aa4f99aa89d/omero_server-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66f38165247a0acc3abdb31da96b295f0285ba86f21cedd9581e4b57f2bbd153",
"md5": "f1d35150c72fb7a9ca070b14e26efc67",
"sha256": "3bc7fcaf884b3b4b82076ad47f86d8e729f81ca6df8ad29634130fb50892b423"
},
"downloads": -1,
"filename": "omero-server-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "f1d35150c72fb7a9ca070b14e26efc67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 10223,
"upload_time": "2023-10-25T10:25:56",
"upload_time_iso_8601": "2023-10-25T10:25:56.139904Z",
"url": "https://files.pythonhosted.org/packages/66/f3/8165247a0acc3abdb31da96b295f0285ba86f21cedd9581e4b57f2bbd153/omero-server-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 10:25:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "omero-cli-server",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "omero-server"
}
JSON
