OMERO.blitz服务器的Python绑定
项目描述
简介
OMERO.py 为 OMERO.blitz 服务器提供了 Python 绑定,同时还提供了一个可插拔的命令行界面。
依赖项
OMERO.py 的直接依赖项包括
numpy
Pillow >= 10.0.0
安装
我们建议在 Python 虚拟环境中安装 omero-py。您可以使用例如 venv、conda 或 mamba 来创建虚拟环境。
在安装 omero-py 之前,我们建议安装 ZeroC IcePy 3.6 Python 绑定。我们的商业合作伙伴 Glencoe Software 根据所需的 Python 版本和操作系统已生成几个 Python 轮子以安装 Ice-Python 绑定。请访问 OMERO.py 了解支持的平台和 Python 版本列表。
轮子安装后,激活虚拟环境并从 PyPI 安装 omero-py
$ pip install -U omero-py
需要设置环境变量 OMERODIR 以启用某些功能。 $OMERODIR/var/log/ 目录将包含日志文件。 $OMERODIR/etc/grid/config.xml 用于存储配置。
如果 OMERODIR 设置为 OMERO.server 目录,则将启用 import 和 admin 命令。
# If you need import or admin commands: export OMERODIR=/path/to/OMERO.server/ # otherwise, can choose any location. export OMERODIR=$(pwd)
从版本 5.13.0 开始,使用 omero 证书 是必需的,以确保 OMERO 服务器安装至少有一个自签名证书。
请参阅:[OMERO](https://omero.readthedocs.io/en/stable/index.html) 文档以获取更多详细信息以及 [OMERO 服务器证书管理插件](https://pypi.ac.cn/project/omero-certificates/)
用法
有关命令行使用方法,请参阅 [OMERO.CLI](https://omero.readthedocs.io/en/stable/users/cli/index.html)。
有关 API 文档,请参阅 [https://omero-py.readthedocs.io/](https://omero-py.readthedocs.io/)
贡献
请参阅:[OMERO](https://omero.readthedocs.io/en/stable/index.html) 文档
开发者安装
OMERO.py 目前依赖于外部构建的工件,该工件自动捆绑在 PyPI 包中。
对于开发安装,我们建议创建一个与您的 Python 版本和操作系统匹配的 Ice-Python 绑定的虚拟环境,请参阅 [OMERO.py](https://omero.readthedocs.io/en/stable/developers/Python.html)。
激活虚拟环境并克隆此存储库
$ git clone https://github.com/ome/omero-py $ cd omero-py $ python setup.py devtarget $ pip install -e .
这将把 omero-py 安装到您的虚拟环境中作为可编辑的包,因此对 src 文件的任何编辑都应反映在您的安装中。请注意,如果您添加或删除文件,则必须重新运行最后两个步骤。
运行测试
单元测试位于 test 目录下,可以使用 pytest 运行。
集成测试
集成测试存储在主存储库(ome/openmicroscopy)中,并依赖于 OMERO 集成测试框架。请在 [OMERO](https://omero.readthedocs.io/en/stable/index.html) 文档中阅读有关 [运行和编写测试](https://omero.readthedocs.io/en/stable/developers/testing.html) 的内容。
发布流程
此存储库使用 bump2version 来管理版本号。要标记发布,请运行
$ bumpversion release
这将从当前版本中删除 .dev0 后缀,提交并标记发布。
要切换回开发版本,请运行
$ bumpversion --no-tag [major|minor|patch]
根据开发分支是进行主版本、次版本或补丁版本发布,指定major、minor或patch。这还将添加.dev0后缀。
请记住,必须执行git push以推送所有提交和标签,这是非常重要的。
CI流水线将自动将标签部署到PyPI。发布后,将自动在conda-omero-py上打开一个拉取请求,以更新官方的OMERO.py Conda包。
文档
API文档使用Sphinx生成。要生成它
安装Sphinx。
将环境变量NO_TEMP_MANAGER设置为true。
在docs目录中,运行make clean html。
许可证
OMERO.py在GPL v2下发布。
版权
2009-2024,Open Microscopy Environment,Glencoe Software,Inc。
项目详情
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。