Skip to content

Latest commit

 

History

History
175 lines (126 loc) · 5.52 KB

上传pypi包.md

File metadata and controls

175 lines (126 loc) · 5.52 KB
Raw

上传自定义的Python包到pypi

Auth: 王海飞

Data：2020-09-08

QQ群：223058292

WX：wanghaifeige

Email：[email protected]

github：https://github.com/coco369/docker-depth-learning

知乎Docker专栏：https://zhuanlan.zhihu.com/c_1285288092883734528

知乎Python入门专栏：https://zhuanlan.zhihu.com/c_1277570999509757952>

前言

​ 在开发中很多项目都需要使用到共同的功能，如果每个服务都把这个库放置于各自的目录下，维护起来很麻烦，因此把这个公共功能上传到PyPI，通过pip来统一管理。

1. 目录结构

首先将项目的目录组织成如下形式

<my_project>/                 # 项目根目录
|-- <my_package>              # package
|   |-- __init__.py
|   `-- <files> ....          # 代码模块
|-- README.md
|-- License
|-- readme.rst
|-- setup.py
1.1 编写setup.py
from setuptools import setup, find_packages

with open('readme.rst') as f:
    readme = f.read()

setup(
    name="python-aliyun-api-gateway",
    packages=find_packages(),
    version='0.0.1',
    description="aliyun api gateway",
    long_description=readme,
    author="wanghaifei",
    author_email='[email protected]',
    url="https://github.com/coco369/aliyun-api-gateway-python",
    download_url='https://github.com/coco369/aliyun-api-gateway-python',
    keywords=['command', 'line', 'tool'],
    classifiers=["Programming Language :: Python :: 3"],
    include_package_data=True,
    entry_points={
        'console_scripts': [
			"fastspider=fastspider.start:main"
        ]
    },
    install_requires=[
        'python3.7.6',
    ]
)

这里setuptools.setup() 的几个参数的含义如下：

  • name - 项目的名称

  • version - 项目的版本。需要注意的是，PyPI上只允许一个版本存在，如果后续代码有了任何更改，再次上传需要增加版本号

  • author和author_email - 项目作者的名字和邮件

  • description - 项目的简短描述

  • long_description - 项目的详细描述，会显示在PyPI的项目描述页面。上面的例子里直接用了README.md中的内容做详细描述

  • long_description_content_type - 用于指定long_description的markup类型，上面的例子是markdown

  • url - 项目主页的URL，一般给出代码仓库的链接

  • packages - 指定最终发布的包中要包含的packages。上面的例子中find_packages() 会自动发现项目根目录下所有的packages，当然也可以手动指定package的名字

  • install_requires - 项目依赖哪些库，这些库会在pip install的时候自动安装

  • entry_points - 上面的例子中entry_points用来自动创建脚本，上面的例子在pip install安装成功后会创建fastspider这个命令，相当于直接运行fastspider下的start.py文件中的main函数，很方便

  • classifiers - 其他信息，一般包括项目支持的Python版本，License，支持的操作系统。上面的例子中，我们指定项目只能在Python 3上运行，使用MIT License，不依赖操作系统。关于classifiers的完整列表，可参考 https://pypi.org/classifiers/。例子, 如果只支持Python3:

    "Programming Language :: Python :: 3"

  • include_package_data - 项目里会有一些非py文件，比如html和js等，这时候就要靠 include_package_data来指定。指定内容在MANIFEST.in文件中定义。如下所示：

  # 包含单个文件
  include README.md
  include LICENSE
  include fastspider/requirements.txt
  include fastspider/VERSION
  
  # 递归包含某个文件夹下所有内容
  recursive-include fastspider/templates *
  
  # 排除__pycache__文件和以pyc、pyo、pyd结尾的文件
  global-exclude __pycache__ *.py[cod]
1.2 编写readme.rst文件
工具包使用规范
========================

    1. mysql数据库使用
    2. 经纬度转换使用
1.3 license许可文件
Copyright (c) 2019 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.

好了项目的文件编辑好了，接下来我们就可以开始打包我们的项目了。

2. 上传项目到PyPI

我们使用twine上传项目，如果没有安装twine则先安装twine，以及相关的包

pip install --upgrade setuptools wheel twine

执行一下命令，将在项目目录下生成dist文件夹，

python setup.py sdist bdist_wheel

执行完之后，运行下面的命令将库上传

twine upload dist/*

上传完成后，我们的项目就成功地发布到PyPI了。