平时用别人模块用的爽了, 有时候想自己写个模块上传到pypi, 然后用的时候pip安装. 这次简单介绍一下如何打包自己的python模块并上传到pypi.
整体分以下几步:
- 注册pypi账号
- 打包python模块
- 上传
然后就可以用pip直接安装啦, 怎么样是不是很炫酷!
好了, 就介绍到这里吧.
1. 注册pypi账号
去pypi官网注册一个账号
2. 打包python模块
安装setuptools这个模块, 用来打包python模块, 当然其实还有其他的工具, 这里只介绍这一种, 感兴趣的话可以自行搜索.
>>> pip install --upgrade setuptools
项目目录结构
project (总目录)
module(模块目录)
__init__.py
LICENSE.txt(证书)
README.md(文档)
setup.py(打包脚本)
各个文件/目录说明
关于module目录:
把相关模块写在这个下面就行, module是你自己的模块名, 我这里把函数写在init.py中, 这样我们的模块上传之后, 可以直接import. 比如说init.py中有个函数为fun, 那么我们就可以这样使用:
from module import fun
fun()
另外这里要注意一个细节, 由于我们打包的时候setup.py是在上一级的目录中, 所以, 如果这一层想要引用同一目录下面的其他函数, (比如说我们有个utils.py的文件, 我们在里面写了一个get_md5()的函数) , 如果要引用get_md5需要这样写
from module.utils import get_md5
LICENSE.txt
这个不写也可以的其实.
Copyright (c) 2018 The Python Packaging Authority
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.
setup.py
这个文件是一定要有的, 它是安装的必要文件, 具体的东西看下面的代码, 东西不多. 自己按照需求填写就好.
"""A setuptools based setup module.
See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""
# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
here = path.abspath(path.dirname(__file__))
# Get the long description from the README file
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
# Arguments marked as "Required" below must be included for upload to PyPI.
# Fields marked as "Optional" may be commented out.
setup(
name='这里是你的模块名字, 和你的module目录名保持一致',
version='版本号(每次更新新的版本这里需要递增)',
author='作者名',
author_email='你的邮箱',
description='模块描述',
long_description=long_description, # 这里是文档内容, 读取readme文件
long_description_content_type='text/markdown', # 文档格式
packages=find_packages(),
classifiers=[ #这里我们指定证书, python版本和系统类型
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires='>=3.6', # 这里指定python版本号必须大于3.6才可以安装
install_requires=['pprint', 'tablestore', 'prettytable'] # 我们的模块所用到的依赖, 这里指定的话, 用户安装你的模块时, 会自动安装这些依赖
)
README.md
这个是文档, 会显示在pypi上你的模块的主页, 最好写的详细一些. 免得用的时候一头雾水.
打包
在setup.py的目录下, 执行:
python setup.py bdist_wheel
这个命令会生成一个wheel包, pip可以直接安装. 执行成功后, 会生成三个目录, module.egg-info , build, dist, 这里我们进入到dist目录中, 会看到有一个后缀为.whl的文件, 这就是最后生成的安装包了, 我们其实可以直接pip install这个文件. 当然, 这里我们选择上传到pypi上供其他人使用.
- 上传
上传使用twine上传, 先安装
>>> pip install twine
在我们刚刚的dist目录执行:
twine upload 你打包好的模块.whl
然后会提示你输入你的pypi账号和密码, 输入完等待上传成功就ok了.
