发布python包到pypi(基于poetry)

本博客大部分参考大佬简书:利用poetry发布你的python package到pipy,亲测可用,如有侵权望告知。

1.在pypi上注册一个自己的账号, 以后你上传的包都会在这个账号下面

2.在你的机器上新建一个虚拟环境

安装poetry
(1)osx/linux 使用下面的安装方法:
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

(2)windows使用下面的安装方法:
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python

(3)直接使用pip安装可是可以的
pip install --user poetry

3.初始化poetry的项目

进入你的项目,并初始poetry,这里会需要你输入一些信息,具体可以看下图
poetry init

***注意 除了Author [None, n to skip]: 这一栏,其它的都可以一路回车

你的项目中会多出一个pyproject.toml, 内容如下

[tool.poetry]
name = "impute_test"
version = "0.1.0"
description = ""
authors = ["Your Name <[email protected]>"]

[tool.poetry.dependencies]
python = "^3.6"

[tool.poetry.dev-dependencies]

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"

下面是我的配置,大家可以参考一下

[tool.poetry]
name = "impute_test"
version = "0.0.1"
description = "测试poetry上传到pipy"
authors = ["fake <[email protected]>"]
license = "MIT"
readme = "README.md"
homepage = "https://github.com/Asdil/impute_test"
repository = "https://github.com/Asdil/impute_test"

[tool.poetry.dependencies]
python = "^3.6"

[tool.poetry.dev-dependencies]

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"

5.添加依赖包

在pip install 一些包的时候会连带安装一些依赖包, 这一步就是指定你项目的依赖包
假设我的impute_test项目只需要numpy这一个依赖包

此时我们在项目的根目录下面
这里我们添加一个numpy, 如下图所示,poetry会自动搜索依赖包的版本
poetry add numpy

添加完成后,pyproject.toml会在[tool.poetry.dependencies]下面添加一个 numpy = "^1.18.0"

[tool.poetry]
name = "impute_test"
version = "0.0.1"
description = "测试poetry上传到pipy"
authors = ["fake <[email protected]>"]
license = "MIT"
readme = "README.md"
homepage = "https://github.com/Asdil/impute_test"
repository = "https://github.com/Asdil/impute_test"

[tool.poetry.dependencies]
python = "^3.6"
numpy = "^1.18.0"

[tool.poetry.dev-dependencies]

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"

如果需要加dev依赖,命令改为:

poetry add 依赖包 --dev : 指定为开发依赖,会写到pyproject.toml中的[tool.poetry.dev-dependencies]区域

接下来我们使用poetry安装依赖包

接下来我们使用poetry安装依赖包
使用poetry install 后面不用跟其它的参数, 如下图所示
poetry install

到此为止, numpy包就已经装在这虚拟环境下面

6.编写你的函数

接下来我们编写我们自己的函数方法

(1)首先建一个文件夹
mkdir impute_test # 文件夹名称与项目文件夹一致
(2)在新建文件夹下面新建.py文件编写你的代码
这里新建了一个impute_test文件夹(和项目同名***)
在impute_test文件夹下面新建了一个test.py文件

7.打包到pypi

假设你的代码已经写好了, 接下来需要上传到pypi

poetry build
poetry publish

***注意poetry publish是需要你输入第一步所创建的pipy账号密码

到此为止,你的项目就已经被打包到了pypi

我们可以使用pip安装该项目

1.安装刚才打包的项目
pip install impute_test
2.使用该项目
from impute_test impute test
print(test.get_random_int(10))

['out']
array([ 0.33083423,  1.30556219,  0.51663068, -0.46981275, -0.08478705,
       -1.02993892, -1.28437747,  0.78650906, -0.81945878,  0.69992749])

8.注意事项

(1) poetry是一个多人协同管理的python环境库
(2) 当你需要更新你的包的时候, 你需要在pyproject.toml更改项目版本version = "0.0.2"
(3) 尽量使用github管理你的包, 每次poetry publish后记得git上去
(4) 如果你的包名已经在pipy上面被别人使用, 则你无法上传到pypi

另注:最好按官网方式下载安装:

https://gitee.com/mirrors/poetry

安装好后,每次调用可运行 source $HOME/.poetry/env 将poetry加载到本虚拟环境。

如果仍然无法poetry add/inatall,请在pyproject.toml下添加如下内容:

[[tool.poetry.source]]
name = **** #仓库用户名
url = **** #仓库地址
default = true

猜你喜欢

转载自blog.csdn.net/qq_36663518/article/details/107408366