在这里我自己写了一个样例:把计算从1加到n的和封成一个python包。
账号准备工作:注册
https://pypi.org/account/register/
注意: 记得进行邮件验证,防止邮件不验证,发送包无法上传的情况。
包内容准备工作:
# -*- coding: utf-8 -*-
def add_sum(a):
'''
计算从1+到a
:param a:
:return:
'''
res = False
if type(a) == int:
sum = 0
for i in range(a + 1): # 实际遍历到n
sum += i
res = True
else:
sum = '{0}不是整型,无法计算'.format(a)
return res, sum
我要上传到Pypi的包,这里是我的目录结构:
LICENSE.txt内容
MIT License
Copyright (c) [2019] [wei.xu]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
LICENSE.txt里面写着开源许可证内容,具体内容请参考:
https://choosealicense.com/
README.md
README.md文件写的是对此次项目包的介绍。
setup.py是最重要的文件
#from distutils.core import setup
from setuptools import setup, find_packages
VERSION = '0.0.1'
tests_require = []
install_requires = []
setup(name='hn_test_sum', # 模块名称
url='https://github.com/xuwei13253838782/hn_test_sum', # 项目包的地址
author="wei.xu", # Pypi用户名称
author_email='143482020@qq.com', # Pypi用户的邮箱
keywords='python django admin autoregister',
description='Automatically register models in the admin interface in a smart way.',
license='MIT', # 开源许可证类型
classifiers=[
'Operating System :: OS Independent',
'Topic :: Software Development',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: Implementation :: PyPy'
],
version=VERSION,
install_requires=install_requires,
tests_require=tests_require,
test_suite='runtests.runtests',
extras_require={'test': tests_require},
entry_points={ 'nose.plugins': [] },
packages=find_packages(),
)
有关setup.py的相关详细介绍,可以参考网址:
https://packaging.python.org/tutorials/packaging-projects/
以上是此案例的包的全部内容。
对内容进行打包:
打包工作主要依赖python的setuptools来完成,在进行下面操作前请使用pip安装它:
pip install setuptools
进入到包的根目录下:
第一步:执行检查setup.py文件命令
python setup.py check
第二步: 执行构建打包命令
python setup.py sdist bdist_wheel
查看根目录下的文件情况:
已经构建打包成功。
第三步:创建一个配置文件
- window下,将.pypric放在C:\User\用户名\下。
- linux下,将.pypric放在~/也就是%HOME目录下。
第四步:上传包有2种方式
第一种:
python setup.py sdist upload
注意: 个人不建议使用这种方式,这个传输是明文传输,账号密码可能被泄露。
第二种:
python -m pip install --user --upgrade twine
python -m twine upload dist/*
注意:不能直接使用twine upload dist/*,必须采用python -m进行使用twine,这里-m是将库中的python模块用作脚本去运行。
上传结果:
注意事件:
1.包名字如果Pypi已经存在,则不能使用相同的。
2.上传包,不可上传2次名称、版本相同的包,如果包代码有所更新,请版本叠加,不能在原有的版本上进行修改,再次上传原有版本。
3.一个版本的项目废弃后,自己删除后,此版本的包名称还是存在的,废弃时间根据引用的次数等来确定,只有官方认定失效后,才能再次使用次版本的包名。
4.setup.py内包名称和你的包目录名称要保持一致。