用于上传到zenodo的命令行工具。
项目描述
OpenSCM Zenodo
用于上传到zenodo的命令行工具。
状态
- 开发中:项目正在积极开发中
完整文档可以在以下位置找到:[openscm-zenodo.readthedocs.io](https://openscm-zenodo.readthedocs.io/en/latest/)。我们建议在那里阅读文档,因为GitHub的查看器无法正确显示内部文档链接。
安装
作为应用程序
如果您想将OpenSCM Zenodo作为应用程序使用,那么我们建议使用“锁定”版本的包。这个版本的包还会锁定所有依赖项的版本,从而减少由于依赖项更新而导致的安装问题。
可以使用以下命令安装OpenSCM Zenodo的锁定版本
=== "pip" sh pip install openscm-zenodo[locked]
作为库
如果您想将OpenSCM Zenodo作为库使用,例如您想将其作为另一个包/应用程序的依赖项使用,那么我们建议使用以下命令安装包。这种方法提供了所有依赖项可能的最松散的锁定。这给了您,包/应用程序的开发者,尽可能多的自由来设置不同包的版本。然而,这种自由的代价是您可能安装OpenSCM Zenodo依赖项的不兼容版本(我们无法测试所有依赖项的组合,尤其是尚未发布的版本!)。因此,您可能会遇到安装问题。如果您认为这是由于OpenSCM Zenodo的问题,请[提出问题](https://github.com/openscm/OpenSCM-zenodo/issues)。
可以使用以下命令安装OpenSCM Zenodo的非锁定版本
=== "pip" sh pip install openscm-zenodo
对于开发者
对于开发,我们依赖[pdm](https://pdm-project.org/en/latest/)来管理所有依赖项。要开始,您需要确保pdm已安装([安装说明](https://pdm-project.org/en/latest/#installation),尽管我们发现使用[pipx](https://pipx.pypa.io/stable/installation/)安装对我们来说效果很好)。
对于我们的所有工作,我们使用我们的Makefile
。如果您愿意,可以阅读说明并手动运行命令,但我们通常不推荐这样做,因为它可能存在错误。要创建您的环境,请运行make virtual-environment
。
如果有任何问题,Makefile
的消息应该会引导您通过。如果没有,请[在问题跟踪器中提出问题](https://github.com/openscm/OpenSCM-zenodo/issues)。
有关我们的其他开发者文档,请参阅[开发][development]。
原始模板
该项目是从以下模板生成的:[copier core python repository](https://gitlab.com/znicholls/copier-core-python-repository)。[copier](https://copier.readthedocs.io/en/stable/)用于管理和分发此模板。
项目详情
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于[安装包](https://packaging.pythonlang.cn/tutorials/installing-packages/)的信息。