README

关于

此存储库包含Materials MarketPlace标准应用API规范。该API用作Materials MarketPlace平台应用程序之间交互的基础。

此存储库包含API版本：0.6.0。

作者

• Simon Adorf (simon.adorf@epfl.ch)
• MarketPlace联盟合作伙伴

规范

该仓库包含API的程序化定义（通过Pydantic和FastAPI实现），位于marketplace_standard_app_api/main模块中，以及OpenAPI的等效表示，存储在openapi.json文件中。程序化检查会执行以确保这两种表示保持同步且无冲突。如果Python模块中的定义与OpenAPI JSON文件由于任何原因发生冲突，则以前者为准。

提示：您可以使用marketplace-standard-app-api show命令从Python模块生成OpenAPI文件（需要安装cli扩展）。

安装

注意：用户应使用MarketPlace Python SDK进行应用程序开发。

您可以使用以下命令从PyPI安装此包：

pip install marketplace-standard-app-api

测试

此仓库的测试是通过pytest实现的。要运行这些测试，首先使用以下命令安装测试依赖项：

pip install '.[tests]'

然后使用pytest命令运行测试。

贡献

欢迎以问题、评论和拉取请求的形式贡献。

要贡献代码，请fork此仓库，然后创建一个拉取请求。为了开发，您需要设置一个Python环境（使用最新版本的Python），安装开发依赖项，并使用以下命令安装pre-commit钩子：

pip install pre-commit==2.17.0
pre-commit install

维护者

要创建新版本，请克隆仓库，使用pip install -e '.[dev]'安装开发依赖项，然后执行bumpver update --[major|minor|patch]。这将

1. 创建带有提升版本的有标签版本，并将其推送到仓库。
2. 触发GitHub Actions工作流程，创建GitHub版本并发布到PyPI。

附加说明

• 本项目遵循语义版本控制。
• 使用--dry选项预览发布更改。

致谢

本工作得到由Horizon 2020资助的MarketPlace项目的支持，该项目在H2020-NMBP-25-2017征集（资助号760173）下进行。