distriploy 0.16

用法

安装后，通常使用以下方式从您的仓库根目录调用distriploy

distriploy

或

python -m distriploy

在运行之前，仓库应该已配置，请参阅配置。

使用–help运行它以了解选项。

在运行distriploy之前，您可能想要创建一个自定义标签。它将用于命名发布。例如。

git tag -s r$(date +%Y%m%d)

安装

distriploy可在PyPI上获得

python -m pip install --user distriploy

或者您可以获取一个发布或克隆存储库并使用它。

配置

一个启用的仓库在其根目录中有一个.distriploy.yml文件。请参阅此仓库以获取灵感。

该文件是YAML，它包含一个具有以下成员的对象

• release：发布信息对象

• release.method：发布方法。支持的值包括

  • github：该项目有一个GitHub仓库。

    如果有的话，可以提供其他信息

    • release.remote：字符串，可选（默认为origin）

      本地Git仓库远程对应于GitHub。

    • postrelease.add_mirror_urls：布尔值（默认为false）

      是否将镜像列表添加到发布说明中。由于如果GitHub宕机，列表将不可访问，因此有限使用。

    • 环境变量GITHUB_TOKEN，必须由用户设置，包含从https://github.com/settings/tokens创建的token字符串

      例如，设置它。

      read GITHUB_TOKEN
      export GITHUB_TOKEN

      或者添加到环境文件中（不在版本控制之下）。

• mirrors：镜像信息对象，包含以镜像处理程序为键的成员。

  每个条目包含

  mirrors.${mirror}.method：镜像上传方法。支持的值（不支持的将被忽略，并显示警告）是（待定）

  • osf：上传到https://osf.io

    使用要求安装带有osf选项的版本，或者随后安装osfclient依赖项。

    如果有的话，可以提供其他信息

    • project：字符串，OSF项目密钥

    • folder：字符串，OSF文件文件夹

    • name：字符串，可选（默认为发布工件名称）

      如果使用OSF的版本控制系统，则非常有用。

    • 环境变量OSF_USERNAME和OSF_PASSWORD，必须由用户设置，它们来自https://academictorrents.com/about.php#apikeys中的uid & pass

      例如，设置它。

      read OSF_USERNAME OSF_PASSWORD
      export OSF_USERNAME OSF_PASSWORD

      或者添加到环境文件中（不在版本控制之下）。

  • rsync：使用rsync上传

    如果有的话，可以提供其他信息

    • remote：字符串，rsync目标

    • public：字符串，公共URI前缀，上传完成后可访问

  • academictorrents：创建种子文件，并将其上传到https://academictorrents.com

    种子文件将在当前工作目录下生成，其名称与发布工件相同，并添加`.torrent`扩展名。

    如果有的话，可以提供其他信息

    • params：对象，学术种子上传参数，需要通过POST发送

    • 环境变量ACADEMICTORRENTS_USERNAME和ACADEMICTORRENTS_PASSWORD，必须由用户设置，它们来自https://academictorrents.com/about.php#apikeys中的uid & pass

      例如，设置它。

      read ACADEMICTORRENTS_USERNAME ACADEMICTORRENTS_PASSWORD
      export ACADEMICTORRENTS_USERNAME ACADEMICTORRENTS_PASSWORD

      或者添加到环境文件中（不在版本控制之下）。

待定

• 获取一些使用和反馈

许可协议

MIT.

发布

read version # eg. 0.14
sed -i -e 's/^version = .*/version = "'${version}'"/g' setup.py
git add setup.py
git commit -m "preparation for v${version}"
git tag --annotate --message "" v${version}
git push; git push --tags
rm -rf dist; python setup.py sdist && twine upload dist/* -r pypi
python -m distriploy