未提供项目描述
项目描述
关于
pop-create-idem 是 pop-create 的扩展,用于为新的 idem-cloud 项目生成样板代码。 pop-create-idem 包含将 CloudSpec 字典转换为 idem 状态、工具和执行模块的代码。您独特的 pop_create 插件的目的是将 API 文档转换为 CloudSpec 格式。
注意:建议在创建新的 Idem 提供者插件时使用 Python 虚拟环境。
入门指南
在开始之前,请确保您已安装Python 3.8或更高版本。如果您正在运行3.7或更低版本,您可能需要在教程中其他命令中使用python3而不是python。
要验证您的Python版本,请运行以下命令
python -V
接下来,创建您的虚拟环境
python -m venv env
source env/bin/activate
现在您应该已经进入了您的新Python虚拟环境。
更新pip
接下来,更新虚拟环境内pip的最新版本
pip install -U pip
安装依赖项
接下来,您需要安装pop-create
pip install pop-create
现在您可以使用pop-create命令创建Idem插件了。
安装pop-create-idem
从项目根目录使用pip安装pop-create-idem
pip install -e {project_root}
接下来,从PyPi使用pip安装pop-create-idem
pip install pop-create-idem
生成Idem Cloud插件
现在您可以使用pop-create生成Idem插件。您可以选择手动生成一个骨架项目来编写exec和state模块,或者根据您的云OpenAPI或Swagger规范完全自动生成您的插件。
骨架插件
要生成新的骨架Idem Cloud插件,请运行以下命令
pop-create idem-cloud --directory /path/to/new/project --project-name=idem-{my_cloud} --simple_cloud_name={my_cloud} --author={company_name}
此命令创建了一个新的项目,其中包含了启动插件所需的目录结构。
有关开发Idem插件的信息,请参阅创建Idem提供者插件。
Swagger规范
要使用Swagger规范生成新的Idem插件,请运行以下命令
pop-create swagger --directory /path/to/new/project --specification={swagger-spec-yaml-or-accessible-swagger-spec-json-url} --project-name=idem-{my_cloud} --simple_cloud_name={my_cloud} --author={company_name}
OpenAPI3规范
要使用OpenAPI3规范生成新的Idem插件项目,请运行以下命令
pop-create openapi3 --directory /path/to/new/project --specification={openapi3-spec-yaml-or-accessible-openapi3-spec-json-url} --project-name=idem-{my_cloud} --simple_cloud_name={my_cloud} --author={company_name}
此命令创建了一个新的项目,其中包含了启动各自云提供商所需的样板代码。
下一步
在您生成Idem插件后
配置您的插件以适应您的提供商。请参阅快速入门以获取说明。
尝试示例Swagger petstore教程从Swagger自动生成Idem插件,该教程将指导您使用Swagger规范生成Idem插件。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源分发
构建分发
pop-create-idem-4.5.1.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 2692dea3eb770fe7584d361b51d88ed29c5b04cd801d3eca5ec8a3586c3d430e |
|
MD5 | c6117c5c9fe546b259ac9f5ebf27583b |
|
BLAKE2b-256 | d4523ca03bcf4b13e635f9e32f884d42c452e5f5758db39fd2f695f955609195 |
pop_create_idem-4.5.1-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | fa9c03be8ea9dcae0b595e3b0fec88463ddbc49c26d65317217c682af1c1ab50 |
|
MD5 | dd60ce8675d2789d5207d1f18cec5bc0 |
|
BLAKE2b-256 | a06d4d56508e3b809e2fb818eabf2f17ba45f58c9c615fc3318202842d19334f |