commonutilslib 0.1.0

开发工作流

工作流支持以下步骤

• lint
• test
• build
• document
• upload
• graph

这些操作由_ci/scripts目录下的相应脚本提供开箱即用的支持，这些脚本具有基于最佳实践的正常默认值。 在mac或linux上的bash中为windows powershell或setup_aliases.sh寻找setup_aliases.ps1将为所有这些命令的外壳提供方便的别名，这些命令的外壳都以下划线开头。

引导脚本在托管虚拟环境的项目目录中创建一个.venv目录。它使用pipenv来实现这一点。 所有其他脚本在执行任何操作之前都会调用它。因此，可以简单地从调用lint开始，这样就可以在实际对项目进行lint操作之前设置所有内容

一旦代码准备好交付，就应该调用标记脚本，接受语义版本控制方案后面的三个参数patch、minor、major中的一个。 因此，对于最初的交付，我们将调用

$ _tag –minor

这将使项目的版本在git中将其标记为0.1.0，并执行推送操作，同时请求更改并使用提供的版本和更改自动更新history.rst。

因此git初始化后的完整工作流是：

• repeat as necessary (of course it could be test - code - lint :) )
  • code
  • lint
  • test
• commit and push
• develop more through the code-lint-test cycle
• tag (with the appropriate argument)
• build
• upload (if you want to host your package in pypi)
• document (of course this could be run at any point)

重要信息

此模板基于pipenv。为了与Advest.TXT兼容，所以实际创建的包可以被现有Python生态系统的任何部分使用，需要一些黑客。 因此，当用这个构建包时，不要简单调用

$ python setup.py sdist bdist_egg

，因为这将产生一个文件丢失的不可用工件。 相反，使用提供的构建和上载脚本来创建工件中所有必需的文件。

项目特征

• 请参阅usage.rst