司开星的博客

如何向PyPi(pip)提交模块

发表于  |    |   分类于 ，   |   阅读次数

向 https://pypi.python.org/pypi 提交自己的模块步骤如下：

  • 在模块中添加几个必需文件；
  • 使用打包命令将模块打包；
  • 使用twine将模块上传到pypi。

所需文件

setup.py

setup.py 中包含了你要提交模块的大部分信息。其写法如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
from setuptools import setup, find_packages

setup(
    # 以下为必需参数
    name='sampleproject',  # 模块名
    version='1.2.0',  # 当前版本
    description='A sample Python project',  # 简短描述
    py_modules=["my_module"], # 单文件模块写法
    # ckages=find_packages(exclude=['contrib', 'docs', 'tests']),  # 多文件模块写法
    
    
    # 以下均为可选参数
    long_description="",# 长描述
    url='https://github.com/pypa/sampleproject', # 主页链接
    author='The Python Packaging Authority', # 作者名
    author_email='pypa-dev@googlegroups.com', # 作者邮箱
    classifiers=[
        'Development Status :: 3 - Alpha',  # 当前开发进度等级（测试版，正式版等）

        'Intended Audience :: Developers', # 模块适用人群
        'Topic :: Software Development :: Build Tools', # 给模块加话题标签

        'License :: OSI Approved :: MIT License', # 模块的license

        'Programming Language :: Python :: 2', # 模块支持的Python版本
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
    ],
    keywords='sample setuptools development',  # 模块的关键词，使用空格分割
    install_requires=['peppercorn'], # 依赖模块
    extras_require={  # 分组依赖模块，可使用pip install sampleproject[dev] 安装分组内的依赖
        'dev': ['check-manifest'],
        'test': ['coverage'],
    },
    package_data={  # 模块所需的额外文件
        'sample': ['package_data.dat'],
    },
    data_files=[('my_data', ['data/data_file'])], # 类似package_data, 但指定不在当前包目录下的文件
    entry_points={  # 新建终端命令并链接到模块函数
        'console_scripts': [
            'sample=sample:main',
        ],
        },
        project_urls={  # 项目相关的额外链接
        'Bug Reports': 'https://github.com/pypa/sampleproject/issues',
        'Funding': 'https://donate.pypi.org',
        'Say Thanks!': 'http://saythanks.io/to/example',
        'Source': 'https://github.com/pypa/sampleproject/',
    },
)

readme

模块可以包含一个使用rst或markdown写的readme说明文件。

licence.txt

开源模块一般会选择一个license表明他人可以如何使用此模块。如果不知道选哪个可以使用https://choosealicense.com/辅助选择。

其他

另外还有一些文件MANIFEST.in（填写模块所需的额外文件），setup.cfg（setup初始化文件）可以在官方文档查找用法。

打包项目

1
2
3
4
pip install wheel # 安装wheel模块

python setup.py sdist  # 源码包
python setup.py bdist_wheel --universal # 打包为无需build的wheel。其中--universal表示py2和py3通用的pure python模块。不满足通用或pure条件的模块不需加此参数

上传项目

先在pypi注册一个账户：https://pypi.org/account/register/

然后安装上传所需模块：

pip install twine

最后上传：

twine upload dist/*

参考资料

《Packaging and Distributing Projects》