[TOC]

docs

• 这个链接总体介绍，start here：https://packaging.python.org/tutorials/distributing-packages/
• https://setuptools.readthedocs.io/en/latest/setuptools.html
• 创建发布包： https://docs.python.org/2/distutils/sourcedist.html

Initial Files

setup.py

• 工程信息配置
• 命令行接口，实现不同功能： python setup.py install

setup.cfg

setup.py 的一些默认配置

README.rst

等同于README.md，*.rst语法与md不同

MANIFEST.in

非代码文件也要打包到发布包中，需要这个文件

LICENSE.txt

参考： https://choosealicense.com/

<your package>

模块名

setup() 函数

配置项目的一些细节

name

PyPi 上显示的名字,

version

版本

description、long_description

描述

url

homepage url, 比如github链接

author, author_email

author='The Python Packaging Authority',
author_email='pypa-dev@googlegroups.com',

license

license='MIT',

classifiers

分类器，在pypi上能被搜索到，详细信息参考： https://pypi.python.org/pypi?%3Aaction=list_classifiers

keywords

关键描述

packages

包含python package：

• packages=find_packages(exclude=['contrib', 'docs', 'tests*']),
• 手工列出所有的python 包

install_requires

工程依赖包说明，有两种实现方式：

• install_requires = ['A>=1,<2', 'B>=2']
• requirements.txt 推荐用这种

install_requires vs Requirements.txt: https://packaging.python.org/discussions/install-requires-vs-requirements/#install-requires-vs-requirements-files

python_requires

• python 版本要求： python_requires='>=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4',
• 该参数的版本要求： pip >= 9.0.0, setuptools >= 24.2.0

include_package_data=True, package_data = {}

包相关的文件，实现的两个步骤：

1. include_package_data=True
2. package_data 声明如下

package_data={
    'sample': ['package_data.dat'],
},

data_files=[(directory, files)]

扩展package_data的功能, 比如数据文件放到包之外的其他目录，配置说明

• files： 要打包的文件列表，
• directory： 文件列表要放置的目录

demo: data_files=[('my_data', ['data/data_file'])],
docs： https://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files

scripts

安装shell命令，首行必须声明使用python，不推荐用这种方式，推荐使用console_scripts

entry_points

类似于jndi，按组注册一些插件，或者命令行工具，可以提供给开发者使用，这东西挺麻烦的，不懂有没人使用这个机制，可替代的简单方案多。不建议深入了解。相关docs：

• demo：http://reinout.vanrees.org/weblog/2010/01/06/zest-releaser-entry-points.html
• command line tool demo:
  • https://setuptools.readthedocs.io/en/latest/setuptools.html#automatic-script-creation
  • http://bingotree.cn/?p=178
  • https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points

版本定义

• 版本定义主格式： MAJOR.MINOR.MAINTENANCE（PATCH）
  • MAJOR：重大api改变，如修改api，丢弃某些api
  • MINOR：增加向后兼容的API
  • PATCH：bug fixes
• 版本定义语法： https://packaging.python.org/tutorials/distributing-packages/#choosing-a-versioning-scheme
• 版本定义公约： http://semver.org/

其他格式的版本定义

• 基于日期： 12.04， 15.10
• 基于系列： 1.0，2.0，3.0
• 混合：2017.1，2017.16
• local version identifiers： <public version identifier>+<local version label>
  • 1.2.0.dev1+hg.5.b11e5e6f0b0b
  • 1.2.1+fedora.4

开发模式

• pip install -e . (在源码目录安装)
• pip install -e git+https://somerepo/bar.git#egg=bar
• pip install -e /path/to/project/bar

requirements.txt

• demo1(注意顺序):

-e /path/to/project/bar
-e .

• demo2（注意顺序）:

-e .
-e git+https://somerepo/bar.git#egg=bar

Source Distributions

python setup.py sdist

Wheels

debuging

设置DISTUTILS_DEBUG环境变量