在 PyPI 上发布 python 包-白红宇

在 PyPI 上发布 python 包

阅读量：4100 次

发布时间：2019-05-25

本文共 3361 字，大约阅读时间需要 11 分钟。

PyPI（Python Package Index）是 Python 官方的包存储仓库。PyPI 推荐使用 pip（python install packages，Python 包管理工具）来下载储存在 PyPI 库中的 python 包。本文内容主要介绍如何在 PyPI 上发布自己编写的 python 包。

参考链接：

自己编写好的 python 项目存放在 /home/cropgbm_python/cropgbm/ 文件夹下，希望将 cropgbm/ 打包并上传至 PyPI 中。

1. 创建 init.py 文件

首先在 /home/cropgbm_python/cropgbm/ 目录下创建 __init__.py 空文件。

2. 创建 MEADME.md 文件

在 /home/cropgbm_python/ 目录下创建 MEADME.md 文件。这里的 MEADME.md 复制于 Readmd.md，仅更改了文件名。

注意！文件名必须是 [README, README.rst, README.txt, README.md] 中一种，否则在打包时会出现警告：

warning: sdist: standard file not found: should have one of README, README.rst, README.txt, README.md

3. 创建 setup.py 文件

在 /home/cropgbm_python/ 目录下创建 setup.py 文件。setup.py 指定包的相关信息（如名称、版本、依赖等）以及所要包括的代码文件。

setup.py 文件的一般格式如下。

from setuptools import setup, find_packagessetup(    name='cropgbm',    version='1.1.1',    description=(    	'Crop Genomic Breeding machine (CropGBM) is a multifunctional program     	 that integrates data preprocessing, population structure analysis, SNP selection,     	 phenotype prediction, and data visualization.'    	 ),    long_description=open('README.md').read(),    author='Yuetong Xu, Jun Yan',    author_email='yuetong_xu@163.com',    maintainer='Yuetong Xu',    maintainer_email='yuetong_xu@163.com',    license='MIT License',    url='https://github.com/YuetongXU/CropGBM',    packages=find_packages(),    entry_points={    'console_scripts': [        'cropgbm = cropgbm.main:main',        ]    },    package_data={        'cropgbm': ['testdata/*']    },    classifiers=[        'Operating System :: OS Independent',        'License :: OSI Approved :: MIT License',        'Programming Language :: Python :: 3'    ],    python_requires='>=3',    install_requires=[        'wheel',		'numpy',		'scipy',		'pandas',		'scikit-learn>=0.24',		'lightgbm',		'matplotlib',		'seaborn'    ])

name - 包的名字

version - 包的发布版本号

description - 包的简要描述

long_description - 包的详细描述，内容会展示在 PyPI 的包首页上。这里使用的是 README.md 文件，此文件也是我 github 中 cropgbm 项目的 README.md。

url - 包主页的 URL，内容会展示在 PyPI 的包首页上。一般 URL 为 GitHub 等的代码托管服务的链接。

packages - 包的代码所在目录。这里使用 find_packages() 函数，将包含 __init__.py 文件的目录作为要打包的代码。如本例会将 /home/cropgbm_python/cropgbm/ 文件夹进行打包。

package_data - 包的非 .py 文件所在目录。由于 find_packages() 函数仅会打包目录下的 .py 文件，如果需要在包中加入非 .py 文件，可以通过该参数指明路径。

entry_points - 为包添加命令行工具。 ‘cropgbm = cropgbm.main:main’ 指 python 包安装时会在 /usr/local/bin/ 路径下创建一个名为 cropgbm 的文件，此文件链接的是 cropgbm 包中 main.py 脚本中的 main 函数（ “:” 指明是文件中的函数）。