数据管理向导模板开发工具包
dsw-tdk的Python项目详细描述
dsw tdk公司
Template Development Kit for Data Stewardship Wizard
安装
Python包
$ pip install dsw-tdk
或者，您可以从此存储库克隆任何版本并直接安装：
^{pr2}$我们建议使用virtual environments，以避免与其他项目的依赖项发生冲突。在
停靠工具
如果您不想在您的机器上直接使用Python，您可以轻松地将Docker image与DSW TDK一起使用：
$ docker run datastewardshipwizard/dsw-tdk --help
$ docker run datastewardshipwizard/dsw-tdk:develop --help
请参阅datastewardshipwizard/dsw-tdk on Docker Hub以检查可用的标记。在
使用
您可以直接使用--help标志来找出可能性：
$ dsw-tdk --help $ dsw-tdk put --help
更多信息，请访问我们的documentation。在
基本命令
new=使用交互式向导在本地创建新的模板项目list=列出配置的DSW实例中可用的模板get=从DSW实例下载模板put=将模板上载到DSW实例（创建或更新）verify=检查本地模板项目的元数据package=创建可通过web界面导入到DSW的分发ZIP包
环境变量
可以使用以下环境变量来避免重复CLI选项。在
DSW_API=DSW API的URL，例如https://api.demo.ds-wizard.org（请注意，不是客户端的URL，您可以在DSW中单击“帮助”>；“关于”找到它）- 未指定
--api-server时使用
- 未指定
DSW_USERNAME=您使用管理员帐户登录的用户名（电子邮件地址）- 未指定
--username时使用
- 未指定
DSW_PASSWORD=使用管理员帐户登录的相应密码- 未指定
--password时使用
- 未指定
您也可以在从当前目录自动加载的.env文件中使用它们，或者使用--dot-env选项指定它：
$ ls -a . .. .env my-other-file $ dsw-tdk list $ dsw-tdk --dot-env /path/to/my/.env list
如何启动
- 准备您的DSW实例和管理帐户（可选地，准备
.env文件） - 通过发出
dsw-tdk list验证连接 - 创建一个新的模板项目
dsw-tdk new或获取现有的dsw-tdk get（或重用一些本地的） - 转到模板项目并进行所需的编辑
- 使用
dsw-tdk put（或继续使用dsw-tdk put --watch）更新DSW中的模板 - （或）使用
dsw-tdk package创建可通过DSW web界面导入的分发ZIP包
冗长性
您可以使用--quiet和--debug标志来切换较少或更多的输出消息：
$ dsw-tdk --quiet list $ dsw-tdk --debug list
要求
- Python 3.6+
- 具有匹配版本的DSW实例（例如使用Docker的本地实例）
- DSW实例的管理员凭据（电子邮件+密码）
贡献
我们欢迎任何形式的反馈和对此工具的贡献：
- 使用GitHub Issues报告错误或询问。在
- 使用DSW Ideas site共享想法和功能请求。在
- 使用Pull Requests提交增强功能，请确保遵守使用的约定。在
许可证
这个项目是在Apache2许可证下授权的-有关更多详细信息，请参阅LICENSE文件。在
- 项目
标签：
欢迎加入QQ群-->： 979659372
