美文网首页Python相关的文章
利用poetry发布你的python package到pipy

利用poetry发布你的python package到pipy

作者: AsdilFibrizo | 来源:发表于2019-12-27 17:19 被阅读0次

    这是一个简单的教程教你如何打包自己的库到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

    相关文章

      网友评论

        本文标题:利用poetry发布你的python package到pipy

        本文链接:https://www.haomeiwen.com/subject/lysdoctx.html