.metadata是什么项目文件_Python项目打包发布到pypi

最近心血来潮，想把自己的写的python项目打包到pypi,也让广大朋友能够通过pip来安装我的python包。

第一次尝试，中间遇到了一些问题，记录下来，方便其他感兴趣的朋友。

项目组织架构

# tree 
.
├── LICENSE
├── pg_client
│   ├── __init__.py
│   └── pg_operator.py
├── README.md
└── setup.py

• LICENSE：可以通过github创建项目的时候选择，选择“MIT License”,后面需要添加对应的License版本
• README.md：项目的介绍
• setup.py：打包时用到的元数据信息
• pg_client: 项目主要代码目录，名字可以根据项目需要定义

setup.py文件

import setuptools

with open("README.md", "r") as fh:
    long_description = fh.read()

setuptools.setup(
    name="pypostgrestool",
    version="0.1",
    author="zhangjx",
    author_email="[email protected]",
    description="SDK about postgres",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/ThinkBlue1991/pgpool",
    packages=setuptools.find_packages(),
    install_requires=['psycopg2==2.8.5'],
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
)

• name : 软件包的名称。该名称由字母，数字，_和-组成。并且不能与其他已经上传至pypi.org的项目相同
• version: 软件包的版本
• author: 作者
• author_email : 作者邮箱地址
• description ：软件包的描述信息
• long_description : 软件包的长描述信息
• url ：软件包的主页链接,常见的github路径较多
• classifiers ： 当前软件包的其他元数据信息(metadata)。例如兼容的python版本和操作系统；提供的功能的类型及许可证等等。应当总是至少包括当前软件包所支持的python版本，操作系统和许可证信息
• packages ：包含在发布软件包文件中的可被import的python包文件。我们可以手动罗列所有文件。或者使用函数setuptools.find_packages()自动包含所有的python包文件以及子包文件
• install_requires：指定了当前软件包所依赖的其他python类库。这些指定的python类库将会在本package被安装的时候一并被安装

__init__.py文件

填写import导入，这样在安装之后，就能够直接通过import到自己的项目中使用，比如：

# cat pg_client/__init__.py 
from pg_client.pg_operator import PostgresDB

安装完成之后，通过from pg_client import PostgresDB来使用PostgresDB这个类对象

打包

• 安装打包工具

pip3 install whell  -y
pip3 install twine -y

• 打包

python3 setup.py sdist bdist_wheel

输出结果

# tree
.
├── build
│   ├── bdist.linux-x86_64
│   └── lib
│       └── pg_client
│           ├── __init__.py
│           └── pg_operator.py
├── dist
│   ├── pypostgrestool-0.1-py3-none-any.whl
│   └── pypostgrestool-0.1.tar.gz
├── LICENSE
├── pg_client
│   ├── __init__.py
│   └── pg_operator.py
├── pypostgrestool.egg-info
│   ├── dependency_links.txt
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   └── top_level.txt
├── README.md
└── setup.py

dist下的文件是需要上传到pypi下的

上传pypi

• 注册

通过pypi注册页面进行pypi用户注册 - 上传

# twine upload dist/*
Uploading distributions to https://upload.pypi.org/legacy/
Enter your username:

输入用户名和密码就能够上传到pypi下。 - 登陆到pypi查看自己的项目