GitHub的distribute/setuptools/distutils命令。您可以使用GitHub下载代替PyPI下载进行发布。
项目描述
简介
Distribute/setuptools/distutils命令用于GitHub。您可以使用GitHub下载代替PyPI下载进行发布。
要使用此命令,请按照以下说明操作。
说明
首先,您的软件必须按照标准分布方式打包:使用distutils,Distribute或setuptools。此软件包包含一个扩展命令。
然后,将此软件包添加到您的setup.py
脚本中的setup_requires
参数。
setup(name='YourPackageName', version='1.2.3', ..., setup_requires=['github-distutils >= 0.1.0'])
现在,您的setup.py
将有一个名为github_upload
的命令。
$ python setup.py github_upload --help Common commands: (see '--help-commands' for more) ... Options for 'github_upload' command: --repository (-R) GitHub repository name e.g. user/reponame --username (-u) GitHub username --password (-p) GitHub password ...
如果未提供-u
/--username
和-p
/--password
,则会显示提示。需要-R
/--repository
。
上传
上传非常简单
$ python setup.py sdist github_upload -R user/reponame register
通过说明
- 构建源分发包
生成源分发包文件。如果你的包名为YourPackageName,版本号为1.2.3,那么它的文件名将是YourPackageName-1.2.3.tar.gz。
- github_upload -R 用户/仓库名
将构建的源分发包文件上传到你的GitHub仓库中。这并不意味着它会受到版本控制,但它将被简单地上传到其下载页面。
- 注册
使用GitHub下载URL将此版本的包注册到PyPI。PyPI页面的URL将是http://pypi.python.org/YourPackageName/1.2.3
默认选项
您可以通过在setup.cfg配置文件中指定来为这些选项设置默认值。例如,如果您想为--repository设置默认值,创建一个类似于以下内容的setup.cfg文件(短划线变为下划线)
[upload] repository = user/reponame
您还可以创建一个简写别名
[aliases] release = sdist github_upload register
针对Bitbucket用户
如果您使用的是Bitbucket而不是GitHub,请使用同一作者编写的bitbucket-distutils包。
变更日志
版本 0.1.1
于2012年6月20日发布。测试版。
允许GitHub仓库名称使用大写字母。[由Xavier Barbosa在#1处提交]
Windows兼容性:修复了上传时的UnicodeDecodeError。
版本 0.1.0
于2012年5月27日发布。第一个测试版。