利用poetry发布你的python package到pipy

这是一个简单的教程教你如何打包自己的库到pipy,这里我使用的环境是Linux

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

注册页面

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

1.我这里使用的是conda安装,其它方法安装也可以,这里安装了一个名为py36的python环境
conda create -n py36 python=3.6
2.切换到该环境
source activate py36
3.安装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

poetry官网在这里, 有兴趣的小伙伴可以看一看

3.在github上面新建一个项目, 并拉到本地

这一步并非必要,你也可以在本地创建一个python项目,不过一般来说用github方面管理
***注意,创建项目的时候最好在pypi上面看看有没有重名

创建完成的项目

4.初始化poetry的项目

1.创建完成之后我们就可以把项目拉倒本地(这是我的项目,需要替换成你的项目)
git clone https://github.com/Asdil/impute_test.git
2.进入你的项目,并初始poetry,这里会需要你输入一些信息,具体可以看下图
poetry init

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


初始化poetry

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

[tool.poetry]
name = "impute_test"
version = "0.1.0"
description = ""
authors = ["Your Name <you@example.com>"]

[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 <fake_add@126.com>"]
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
添加一个numpy依赖包

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

[tool.poetry]
name = "impute_test"
version = "0.0.1"
description = "测试poetry上传到pipy"
authors = ["fake <fake_add@126.com>"]
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"

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

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

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

6.编写你的函数

接下来我们编写我们自己的函数方法,这里我写了一个很简单函数的方法, 具体可以到我的项目里面看

(1)首先建一个文件夹
mkdir impute_test # 文件夹名称与项目文件夹一致
(2)在新建文件夹下面新建.py文件编写你的代码
这里我新建了一个impute_test文件夹(和项目同名***)
在impute_test文件夹下面新建了一个test.py文件, 我的项目代码就写在test.py中,具体可看github中我的项目,上面有链接

7.打包到pipy

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

poetry build
poetry publish

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


上传到pipy

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


已经被上传的项目

我们可以使用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上面被别人使用, 则你无法上传到pipy

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353