python包管理（二）：打包发布

概述

上篇文章介绍了如果通过pip命令来管理其他人已经发布的包。这篇文章我们看下如何把自己的代码打包发布

打包发布

这里使用setuptools来打包
1.确认编写好模块
你要有一个写好的包，可以放在一个目录中，假设你的代码在bao文件夹中

/bao# tree
.
├── Gcc.py
├── __init__.py
└── Pots.py

0 directories, 3 files

__init__.py文件中写好如下内容：

bao# cat __init__.py 
# -*- coding: UTF-8 -*-
__all__ = ["Gcc", "Pots"] #影响能否导入这个包中的哪些模块，只有在这个列表中的文件才被导入
#为了兼容2,3版本，最好使用如下方式导入
from . import *

2.在模块的根目录上创建setup.py文件
现在的目录结构为：

# tree
.
├── bao
│   ├── Gcc.py
│   ├── __init__.py
│   └── Pots.py
├── README.md
└── setup.py

1 directory, 5 files

文件内容大致如下：

from distutils.core import setup
setup(name='test',
      version='1.0',
      description='a test python packge', 
      author='Kellan Fan', 
      author_email = 'kellan@kellan.com',
      packages = find_packages()

针对参数做下简单的介绍（详细信息可执行python3 setup.py --help获取）：

• name 包名称------------生成的包名称
• version (-V) 包版本----生成包的版本号
• author 程序的作者------包的制作者名字
• author_email 程序的作者的邮箱地址
• maintainer 维护者
• maintainer_email 维护者的邮箱地址
• url 程序的官网地址
• license 程序的授权信息
• description 程序的简单描述-------程序的概要介绍
• long_description 程序的详细描述---程序的详细描述
• platforms 程序适用的软件平台列表
• classifiers 程序的所属分类列表
• keywords 程序的关键字列表
• packages 需要处理的包目录（包含init.py的文件夹）-------和setup.py同一目录下搜索各个含有 init.py的包
• py_modules 需要打包的python文件列表
• download_url 程序的下载地址
• cmdclass
• data_files 打包时需要打包的数据文件，如图片，配置文件等
• scripts 安装时需要执行的脚步列表
• package_dir 告诉setuptools哪些目录下的文件被映射到哪个源码包。一个例子：package_dir = {'': 'lib'}，表示“root package”中的模块都在lib 目录中。
• requires 定义依赖哪些模块
• provides定义可以为哪些模块提供依赖
• find_packages() 对于简单工程来说，手动增加packages参数很容易，刚刚我们用到了这个函数，它默认在和setup.py同一目录下搜索各个含有 init.py的包。
  其实我们可以将包统一放在一个src目录中，例如

# tree
.
├── README.md
├── setup.py
└── src
    └── hypernode-report
        ├── config.yml
        ├── data
        │   └── a.dat
        ├── hypernode.py
        ├── __init__.py
        └── resource.py

from setuptools import setup, find_packages
setup(
    packages = find_packages('src'),  # 包含所有src中的包
    package_dir = {'':'src'},   # 告诉distutils包都在src下
 
    package_data = {
        # 任何包中含有.yml文件，都包含它
        '': ['*.yml'],
        # 或者包含hypernode-report包data文件夹中的 *.dat文件
        'hypernode-report': ['data/*.dat'],
    }

另外，也可以排除一些特定的包find_packages(exclude=[".tests", ".tests.", "tests.", "tests"])

• install_requires = ["requests"] 需要安装的依赖包
• entry_points 动态发现服务和插件

3.执行python3 setup.py check 检查setup.py是否有错误或警告

4.执行python3 setup.py sdist 压缩模块
或者python3 setup.py bdist_egg压缩成egg文件，
或者python3 setup.py bdist_wheel压缩成whl文件

~# tree
.
├── bao
│   ├── Gcc.py
│   ├── __init__.py
│   └── Pots.py
├── build
│   ├── bdist.linux-x86_64
│   └── lib
│       └── bao
│           ├── Gcc.py
│           ├── __init__.py
│           └── Pots.py
├── dist  #这下面是最终生成的3种文件
│   ├── kellan_test-0.1-py3.6.egg
│   ├── kellan_test-0.1-py3-none-any.whl
│   └── kellan-test-0.1.tar.gz
├── kellan_test.egg-info
│   ├── dependency_links.txt
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   └── top_level.txt
├── README.md
└── setup.py

7 directories, 15 files

5.安装的话，如果是压缩包，可以解压tgz包，python3 setup.sh install安装；如果是egg文件，可以easy_install xxx.egg安装；如果是whl文件，可以pip install xxx.whl安装。