【python教程】打包和发布自己的项目，让别人去pip

偶尔有梦

@
目录

• 1.环境搭建
  
  
  
  • 1.1 换源
    
  • 1.2 安装wheel
    
  • 1.3 安装twine
    
  • 1.4 注册PyPI账号
    
  
  
• 2.编写setup.py
  
  
  
  • 2.1 项目文件树
    
  • 2.2 编写setup.py文件
    
  
  
• 3.构建
  
• 4.上传
  
  
  
  • ERROR：The user 'XXX' isn't allowed to upload to project ''
    
  • 2024.1.19更新：
    
  
  

1.环境搭建

1.1 换源

• 在pip安装时使用-i参数，可以指定源。以下有许多种国内源可以选择
  

1. https://pypi.tuna.tsinghua.edu.cn/simple
2. http://mirrors.aliyun.com/pypi/simple/
3. https://pypi.mirrors.ustc.edu.cn/simple/
4. http://pypi.hustunique.com/
5. http://pypi.sdutlinux.org/
6. http://pypi.douban.com/simple/

复制代码

1.2 安装wheel

1. pip install wheel -i https://pypi.tuna.tsinghua.edu.cn/simple

复制代码

1.3 安装twine

1. pip install twine -i https://pypi.tuna.tsinghua.edu.cn/simple

复制代码

1.4 注册PyPI账号

去此网址注册一个即可
2.编写setup.py

2.1 项目文件树

• 你的项目可能是这样的...
  

1. xu736946693@ubuntu:~/Desktop/python-template$ tree
2. .
3. ├── bin
4. │   └── start.py
5. ├── conf
6. │   └── yourfile.conf
7. ├── dataBase
8. │   └── yourDB
9. ├── docs
10. │   └── introduction.md
11. ├── lib
12. │   └── yourlib.py
13. ├── LICENSE
14. ├── log
15. │   └── version.md
16. ├── package_name
17. │   ├── __init__.py
18. │   └── module1
19. │       └── __init__.py
20. ├── README.md
21. ├── res
22. │   ├── READMEimgRes
23. │   │   ├── 7ac23192b1904eb790272d8462cec5b8.png
24. │   │   └── d919d615def3466f9ff73488c4e62aac.png
25. │   └── yourResource
26. │       └── resourceFile
27. ├── settings.zip
28. ├── setup.py
29. └── tests
30.     └── test.py
32. 12 directories, 16 files

复制代码

2.2 编写setup.py文件

setup.py文件是用来打包和上传你的包的重要文件，它有固定的编写范式。下面我将给出我的demo并附上详细注释。

1. from setuptools import setup, find_packages
2. from os import path
4. this_directory = path.abspath(path.dirname(__file__))
5. with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
6.     my_long_description = f.read()
9. setup(
10.     # 关于classifiers的描述详见如下
11.     # https://pypi.org/search/?q=&o=&c=Topic+%3A%3A+Software+Development+%3A%3A+Build+Tools
12.     classifiers=[
13.         # 属于什么类型
14.         "Topic :: Software Development :: Libraries :: Python Modules",
16.         # 发展时期,常见的如下
17.         # Development Status:: 1 - Planning
18.         # Development Status:: 2 - Pre - Alpha
19.         # Development Status:: 3 - Alpha
20.         # Development Status:: 4 - Beta
21.         # Development Status:: 5 - Production / Stable
22.         # Development Status:: 6 - Mature
23.         # Development Status:: 7 - Inactive
24.         "Development Status :: 4 - Beta",
26.         # 许可证信息
27.         "License :: OSI Approved :: MIT License",
29.         # 目标编程语言
30.         # Programming Language :: C
31.         # Programming Language :: C++
32.         # Programming Language :: Python :: 3.4
33.         # Programming Language :: Python :: 3.5
34.         # Programming Language :: Python :: 3.6
35.         # Programming Language :: Python :: 3.7
36.         # Programming Language :: Python :: 3.8
37.         # Programming Language :: Python :: 3.9
38.         "Programming Language :: Python :: 3",
39.         "Programming Language :: Python :: 3.3",
40.         "Programming Language :: Python :: 3.4",
41.         "Programming Language :: Python :: 3.5",
42.         "Programming Language :: Python :: 3.6",
43.         "Programming Language :: Python :: 3.7",
44.         "Programming Language :: Python :: 3.8",
45.         "Programming Language :: Python :: 3.9",
47.         # 运行的操作系统
48.         # "Operating System :: POSIX :: Linux",
49.         "Operating System :: Microsoft :: Windows",
51.         # 运行的环境
52.         # "Environment :: GPU :: NVIDIA CUDA :: 12",
54.         # 开发的目标用户
55.         # Intended Audience :: Customer Service
56.         # Intended Audience :: Developers
57.         # Intended Audience :: Education
58.         # ...
59.         # Intended Audience :: End Users/Desktop
60.         # Intended Audience :: Financial and Insurance Industry
61.         # Intended Audience :: Healthcare Industry
62.         "Intended Audience :: End Users/Desktop",
64.         # 自然语言
65.         "Natural Language :: English",
66.         "Natural Language :: Chinese (Simplified)",
68.     ],
70.     # 如果上传时出现ERROR：The user '' isn't allowed to upload to project ''，换个名字，长一点无所谓，不能跟别人重复
71.     name="projectTemplate",
72.     version="1.0.0",
73.     author="Han Xu",
74.     author_email="736946693@qq.com",
75.     description="This is a project template.",
76.     long_description=my_long_description,
78.     # 存放源码的地址，填入gitee的源码网址即可
79.     # url="https://gitee.com/UnderTurrets/",
81.     packages=find_packages(),
83.     # README.md文本的格式，如果希望使用markdown语言就需要下面这句话
84.     long_description_content_type="text/markdown",
86.     # 安装过程中，需要安装的静态文件，如配置文件、service文件、图片等
87.     # data_files=[
88.     #      ("", ["conf/*.conf"]),
89.     #      ("/usr/lib/systemd/system", ["bin/*.service"]),
90.     #            ],
92.     # 希望被打包的文件
93.     # package_data={
94.     #     "":["*.txt"],
95.     #     "bandwidth_reporter":["*.txt"]
96.     #            },
98.     # 不打包某些文件
99.     # exclude_package_data={
100.     #     "bandwidth_reporter":["*.txt"]
101.     #            },
103.     # 表明当前模块依赖哪些包，若环境中没有，则会从pypi中下载安装
104.     # install_requires=["requests",],
106.     # setup.py 本身要依赖的包，这通常是为一些setuptools的插件准备的配置
107.     # 这里列出的包，不会自动安装。
108.     # setup_requires=["",],
110.     # 仅在测试时需要使用的依赖，在正常发布的代码中是没有用的。
111.     # 在执行python setup.py test时，可以自动安装这三个库，确保测试的正常运行。
112.     # tests_require=[
113.     #     "",
114.     # ],
116.     # install_requires 在安装模块时会自动安装依赖包
117.     # 而 extras_require 不会，这里仅表示该模块会依赖这些包
118.     # 但是这些包通常不会使用到，只有当你深度使用模块时，才会用到，这里需要你手动安装
119.     # extras_require={
120.     #     "":  [""],
121.     # },
122. )

复制代码

• 根据自己的需要更改即可
  

3.构建

• 在项目空间下执行如下指令：
  

1. python setup.py sdist bdist_wheel

复制代码

• 可以看到项目下会自动生成build目录和lib目录等：
  

1. xu736946693@ubuntu:~/Desktop/python-template$ tree -L 3
2. .
3. ├── bin
4. │   └── start.py
5. ├── build
6. │   ├── bdist.linux-x86_64
7. │   └── lib
8. │       └── package_name
9. ├── conf
10. │   └── yourfile.conf
11. ├── dataBase
12. │   └── yourDB
13. ├── dist
14. │   ├── projectTemplate-1.0.0-py3-none-any.whl
15. │   └── projectTemplate-1.0.0.tar.gz
16. ├── docs
17. │   └── introduction.md
18. ├── lib
19. │   └── yourlib.py
20. ├── LICENSE
21. ├── log
22. │   └── version.md
23. ├── package_name
24. │   ├── __init__.py
25. │   └── module1
26. │       └── __init__.py
27. ├── projectTemplate.egg-info
28. │   ├── dependency_links.txt
29. │   ├── PKG-INFO
30. │   ├── SOURCES.txt
31. │   └── top_level.txt
32. ├── README.md
33. ├── res
34. │   ├── READMEimgRes
35. │   │   ├── 7ac23192b1904eb790272d8462cec5b8.png
36. │   │   └── d919d615def3466f9ff73488c4e62aac.png
37. │   └── yourResource
38. │       └── resourceFile
39. ├── settings.zip
40. ├── setup.py
41. └── tests
42.     └── test.py

复制代码

4.上传

• 在项目空间下执行如下指令：
  

1. twine upload -u <the usrname of your PyPI account> -p <the password of your PyPI account> dist/<the files you want to upload>

复制代码

• 如果你更新了代码，记得更新setup.py中的版本号，重新构建你的代码，再次上传就好了。
  

ERROR：The user 'XXX' isn't allowed to upload to project ''

• 你的软件包名字是PyPI用以区分的唯一标识，因此必须全球唯一
  

如果上传时出现ERROR：The user 'XXX' isn't allowed to upload to project ''，换个名字，长一点无所谓，不能跟别人重复。
2024.1.19更新：

目前PyPI官方强制要求两步验证，同时关闭了在终端中输入账密上传包的方式。目前需要在账户中设置API才可以上传。

• 设置API
  

• 在家目录建立.pypirc文件。对于windows用户，即'C:\Users\\.pypirc。对于Linux用户，即'~\.pypirc。
  
• twine上传
  

1. twine upload dist/*

复制代码

本文由博客一文多发平台 OpenWrite 发布！

来源:https://www.cnblogs.com/UnderTurrets/p/18377676
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！