Python打包工具 setuptools 的使用

简述

setuptools 是一个 Python 源码打包工具，通过它，我们可以很方便的对我们的 Python 代码进行打包和分发，我们平时使用的很多第三方库，就是通过它进行打包和分发的，所以我们能够很方便的通过 pip 安装和使用，下面简单介绍下打包和分发。​

安装

这里需要安装几个库，setuptools是必须的，还有 wheel，用于打包成 wheel格式的二进制包，twine用于发布到 pypi

1
pip install setuptools wheel twine

项目结构

项目目录树如下
setuptools项目目录

项目根目录下

  • src: 源码存放目录
  • readme.md: 用于编写项目的详细描述，一般用于发布到pypi时，项目主页的描述
  • setup.py: setuptools 打包配置文件

src 源码目录下

  • demo01: Python 包，往后编写的包和Python文件，都放在这个包下，方便以后打包
  • tests: Python包，一般用于编写一些测试文件，打包源码时，忽略这个包下的所有文件

first.py 脚本测试

1
2
3
4
5
def test1()
    print('Hello Test1')

def test2()
    print('Hello Test2')

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
import os


# 读取文件
def read_file(filename):
    with open(os.path.join(os.path.dirname(__file__), filename), encoding='utf-8') as f:
        long_description = f.read()
    return long_description


setup(
    # 基本信息
    name="demo01",  # 项目名，确定唯一，不然上传 pypi 会失败
    version="1.0.0",  # 项目版本
    author='cjlmonster',  # 开发者
    author_email='cjlmonster@163.com',  # 开发者邮箱
    description='这是一个测试项目',  # 摘要描述
    long_description=read_file('readme.md'),  # 详细描述，一般用于 pypi 主页展示
    long_description_content_type="text/markdown",  # 详细描述的文件类型
    platforms='python3',  # 项目支持的平台
    url='https://www.cjlmonster.cn',  # 项目主页

    # 项目配置
    # 包含所有src文件夹下的包，但排除tests包
    packages=find_packages('src', exclude=['*.tests', '*.tests.*', 'tests.*', 'tests']),
    package_dir={'': 'src'},  # find_packages指定了文件夹后，这里也需要配置
    package_data={
        # 任何包中含有.txt文件，都包含它
        '': ['*.txt']

    },
    exclude_package_data={
        # 忽略demo01包下的data文件夹里的abc.txt文件
        'demo01': ['data/abc.txt']
    },
    # 支持Python版本
    python_requires='>=3',
    # 表明当前模块依赖哪些包，若环境中没有，则会从pypi中下载安装
    install_requires=[
        'flask >= 2.0.1',
        'pillow >= 6.2.2, < 7.0.0'
    ],
    # 用来支持自动生成脚本，如下配置
    # 在类Unix系统下，会在 /usr/local/bin下生成 test1和test2 两个命令
    # 在Windows系统下，会在当前Python环境下的 scripts 目录下生成 test1.exe和test2.exe
    entry_points={
        'console_scripts': [
            'test1 = demo01.first:test1',  # 入口指向demo01包下的first文件里的 test1 函数
            'test2 = demo01.first:test2',  # 入口指向demo01包下的first文件里的 test2 函数
        ],
    }
)
  • 编写完配合文件后，可以直接安装源码到本地环境
    1
    python setup.py install
  • 测试阶段不想直接安装到本地的话，可以使用
    1
    python setup.py develop

打包源码

  • 上面开发完项目之后，编写 setup.py 打包配置文件，之后就可以使用 setuptools 打包了，这里打包为 wheel 格式的二进制文件，项目根目录下执行如下命令打包：

    1
    python setup.py bdist_wheel

  • 执行打包命令，会生成一些发布文件：
    bdist_whell

  • 其中 dist 目录下的 demo01-1.0.0-py3-none-any.whl 就是打包好的项目源码，查看它

  • 直接安装到本地：

    1
    pip install dist/demo01-1.0.0-py3-none-any.whl

  • 查看安装依赖

    1
    pip show demo1

  • 脚本命令

    1
    2
    3
    4
    5
    $ test1
    Hello Test1

    $ test2
    Hello Test2

发布

项目开发好后，想分享给更多人使用时，打包后还需要上传到 PyPi （Python Package Index）上，它是 Python 官方维护的第三方包仓库，用于统一存储和管理开发者发布的 Python 包。​

  • 首先需要在 PyPi 上注册账号​

  • 然后在用户家目录下生成 ~/.pypirc 文件，并编写如下内容

    1
    2
    3
    4
    5
    6
    [distutils]
    index-servers = pypi

    [pypi]
    username:xxx
    password:xxx

  • 然后使用这条命令进行信息注册

    1
    python setup.py register

  • 注册完了后，上传源码包

    1
    python setup.py upload

  • 上面的发布是 setuptools 自带的，操作比较麻烦，想要简单点，可以使用 twine 发布工具，直接输入:

    1
    twine upload dist/demo01-1.0.0-py3-none-any.whl

  • 上传到 pypi 后，就可以在 pypi 上看到项目的信息了，并且可以使用 pip 进行安装使用

    1
    pip install demo01

pbr

pbr 是一个对 setuptools 加强的插件，通过它可以将 setup 函数所需的参数放在一个统一的配置文件中集中管理，此外它也带有自动化管理项目版本的功能。pbr 来自于openstack 社区。

最小化的 setup.py 文件

1
2
3
4
5
import setuptools

setuptools.setup(
    setup_requires=['pbr>=2.0.0'],
    pbr=True)

setup.py 所需的实际元数据存储在 setup.cfg

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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
[metadata]
name = nova
summary = Cloud computing fabric controller
description-file =
    README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = https://docs.openstack.org/nova/latest/
classifier =
    Environment :: OpenStack
    Intended Audience :: Information Technology
    Intended Audience :: System Administrators
    License :: OSI Approved :: Apache Software License
    Operating System :: POSIX :: Linux
    Programming Language :: Python
    Programming Language :: Python :: 2
    Programming Language :: Python :: 2.7
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.5

[global]
setup-hooks =
    pbr.hooks.setup_hook

[files]
data_files =
    etc/nova =
        etc/nova/api-paste.ini
        etc/nova/rootwrap.conf
    etc/nova/rootwrap.d = etc/nova/rootwrap.d/*
packages =
    nova

[entry_points]
oslo.config.opts =
    nova.conf = nova.conf.opts:list_opts

oslo.config.opts.defaults =
    nova.conf = nova.common.config:set_middleware_defaults

oslo.policy.enforcer =
    nova = nova.policy:get_enforcer

oslo.policy.policies =
    # The sample policies will be ordered by entry point and then by list
    # returned from that entry point. If more control is desired split out each
    # list_rules method into a separate entry point rather than using the
    # aggregate method.
    nova = nova.policies:list_rules

nova.compute.monitors.cpu =
    virt_driver = nova.compute.monitors.cpu.virt_driver:Monitor

console_scripts =
    nova-api = nova.cmd.api:main
    nova-api-metadata = nova.cmd.api_metadata:main
    nova-api-os-compute = nova.cmd.api_os_compute:main
    nova-cells = nova.cmd.cells:main
    nova-compute = nova.cmd.compute:main
    nova-conductor = nova.cmd.conductor:main
    nova-console = nova.cmd.console:main
    nova-consoleauth = nova.cmd.consoleauth:main
    nova-dhcpbridge = nova.cmd.dhcpbridge:main
    nova-manage = nova.cmd.manage:main
    nova-network = nova.cmd.network:main
    nova-novncproxy = nova.cmd.novncproxy:main
    nova-policy = nova.cmd.policy:main
    nova-rootwrap = oslo_rootwrap.cmd:main
    nova-rootwrap-daemon = oslo_rootwrap.cmd:daemon
    nova-scheduler = nova.cmd.scheduler:main
    nova-serialproxy = nova.cmd.serialproxy:main
    nova-spicehtml5proxy = nova.cmd.spicehtml5proxy:main
    nova-status = nova.cmd.status:main
    nova-xvpvncproxy = nova.cmd.xvpvncproxy:main
    ceph-to-local = nova.cmd.ceph_to_local:main
    local-to-ceph = nova.cmd.local_to_ceph:main
    nova-vcpupin = nova.cmd.vcpupin:main
wsgi_scripts =
    nova-placement-api = nova.api.openstack.placement.wsgi:init_application
    nova-api-wsgi = nova.api.openstack.compute.wsgi:init_application
    nova-metadata-wsgi = nova.api.metadata.wsgi:init_application

nova.ipv6_backend =
    rfc2462 = nova.ipv6.rfc2462
    account_identifier = nova.ipv6.account_identifier

nova.scheduler.host_manager =
    host_manager = nova.scheduler.host_manager:HostManager
    # Deprecated starting from the 17.0.0 Queens release.
    ironic_host_manager = nova.scheduler.ironic_host_manager:IronicHostManager

nova.scheduler.driver =
    filter_scheduler = nova.scheduler.filter_scheduler:FilterScheduler
    caching_scheduler = nova.scheduler.caching_scheduler:CachingScheduler
    chance_scheduler = nova.scheduler.chance:ChanceScheduler
    fake_scheduler = nova.tests.unit.scheduler.fakes:FakeScheduler

[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1

[build_apiguide]
all_files = 1
build-dir = api-guide/build
source-dir = api-guide/source

[egg_info]
tag_build =
tag_date = 0
tag_svn_revision = 0

[compile_catalog]
directory = nova/locale
domain = nova

[update_catalog]
domain = nova
output_dir = nova/locale
input_file = nova/locale/nova.pot

[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = nova/locale/nova.pot

[wheel]
universal = 1

[extras]
osprofiler =
  osprofiler>=1.4.0 # Apache-2.0

OpenStack
Python打包工具 setuptools 的使用
http://mybestcheng.site/2023/01/29/openstack/misc/setuptools/
作者
mybestcheng
发布于
2023年1月29日
许可协议