在PyPI上发布自己的扩展包

• 由于一些(祖传)脚本代码需要来回拷贝调用,所以想是不是可以像numpy一样直接安装使用,所以记录一下如何在PyPI上发布自己的扩展包.

在PyPI网站创建用户

1. 创建一个PyPI账户并登录 在 https://pypi.org/account/register/ 上创建一个新账户，填写必要信息后完成注册。
2. 由于上传需要进行双重验证才能使用(邮箱+设备)

• 在邮箱中有一封确认的链接,进行邮箱确认,不要关闭验证链接,直接在下方进行设备验证.

• 如下图设备验证.(其中第四步: 复制第三步任意一行的code,输入4中进行验证,然后在5中选择添加设备...)

  
  image.png

• 然后创建API-Key,在主页面用户名点击,如下图

  
  image.png

本机电脑配置

• 在本地环境安装: pip install twine
• 创建本地API-Key: vim ~/.pypirc, 写入如下内容,password填入上图生成的token

[pypi]
  username = __token__
  password = pypi-xxxxx

本地包管理

1. 创建如下目录结构

mylibrary
├── setup.py
├── wxw
│   ├── __init__.py
│   └── common.py

• mylibrary是主文件夹,
• wxw库的名称, 例如numpy opencv-python....
• __init__.py是表示当前是一个包的标识,可以是空文件
• common.py是需要用的一些功能函数.
• setup.py文件来定义你的包,这个文件包括了你的包的元数据信息 (如名称、版本号、简介等) 和你的包所需的依赖等信息，同时，它也会告诉Python如何安装你的代码和资源文件。

from setuptools import setup, find_packages

setup(
    name='wxw',  # 库的名称
    version='0.0.1',  # 版本号
    keywords=['pip', 'wxw'],
    description='A library for wxw',  # 简要描述
    long_description="Includes some ways to work with pictures",

    author='xxx',  # 作者名字
    author_email='xxxx@xxx.com',  # 作者邮箱
    url='https://github.com/xxx/xxxx',  # 项目的URL

    packages=find_packages(),  # 需要打包的目录列表
    platforms="any",
    install_requires=["numpy", "opencv-python", "matplotlib"]  # 这个项目依赖的第三方库
)

2. 执行python setup.py sdist会产生如下目录结构

mylibrary
├── dist
│   └── wxw-0.0.1.tar.gz
├── setup.py
├── wxw
│   ├── __init__.py
│   └── common.py
└── wxw.egg-info
    ├── PKG-INFO
    ├── SOURCES.txt
    ├── dependency_links.txt
    ├── requires.txt
    └── top_level.txt

3. 执行twine upload dist/wxw-0.0.1.tar.gz --verbose上传.
   image.png

测试

• 切换个环境进行安装

conda activate lab
pip install wxw

install test
import test
pip list

本地安装

• 也可以本地使用python3 install -e .安装,这样如果common.py中的一些代码如果修改,在调用的时候会同时被修改.
  python3 install -e .