使用poetry来管理python项目

使用poetry来管理python项目

使用poetry来管理python项目，快速的构建开发环境，快速的发布，以及进行第三方库的依赖管理。

使用poetry来管理pytho

setup.py

requirements.txt

setup.cfg

MANIFEST.in

Pipfile

环境：windows10 + Python 3.8.10 + Python 2.7

注：如何并存多个版本的python，见之前的文章 {% post_link windows上同时安装多个版本的python %}

pipx 或者 pip 进行安装：

pipx install poetry  ---推荐

pip install  poetry

注： pipx的安装与介绍后续会单独出文章。

配置全局环境变量（可选，只是为更好的使用）

打开cmd窗口

1.查看当前的poetry环境变量：

$ poetry config --list

cache-dir= "C:\\Users\\zmr\\AppData\\Local\\pypoetry\\Cache"

experimental.new-installer = true

installer.parallel = true

virtualenvs.create = true

virtualenvs.in-project = false

virtualenvs.path = "{cache-dir}\\virtualenvs"  # C:\\Users\\zmr\\AppData\\Local\\pypoetry\\Cache\\virtualenvs

1. 更改缓存目录到其他盘，避免C盘占用

$ poetry config cache-dir E:\TEMP\cache\poetry\cache

2.更改为在当前位置创建虚拟环境，更容易管理

$ poetry config virtualenvs.in-project true

确认更改是生效的

$ poetry config --list

cache-dir= "E:\\TEMP\\cache\\poetry\\cache"

experimental.new-installer = true

installer.parallel = true

virtualenvs.create = true

virtualenvs.in-project = true

virtualenvs.path = "{cache-dir}\\virtualenvs"  # E:\TEMP\cache\poetry\cache\virtualenvs

已有的项目，直接在当前项目的根目录执行poetry init即能根据你回答的问题生成pyproject.toml文件

[tool.poetry]

name = "demo"

version = "0.1.0"

description = ""

authors = ["xxx <xxx@126.com>"]

　　　　　　[tool.poetry.dependencies]

python = "^3.8"

[tool.poetry.dev-dependencies]

[build-system]

requires=["poetry-core>=1.0.0"]

build-backend= "poetry.core.masonry.api"

如果你想创建一个新的 Python项目，使用 poetry new <文件夹名称>命令可以创建一个项目模板：

$ poetry new foo

这会创建一个这样的项目结构：

　　　　foo

　　　　├── pyproject.toml

　　　　├── README.rst

　　　　├── foo

　　　　│   └── __init__.py

　　　　└── tests

　　　　　　　　├── __init__.py

　　　　　　　　└── test_foo.py

注：如果你想使用 src 文件夹，可以添加 --src选项，这会把程序包嵌套在 src 文件夹里。

使用 poetry install命令创建虚拟环境（确保当前目录有 pyproject.toml 文件）：

poetry install

利用 poetry env use创建

$ poetry env use python2

查看当前的环境信息

$ poetry env info

Virtualenv

Python:         2.7.10

Implementation: CPython

Path:       E:\git-code\behave-db\.venv

Valid:          True

System

　Platform: win32

　OS:       nt

Python:  d:\program files\python27

安装包

$ poetry add flask

执行完成后，会自动加到 pyproject.toml 中，下次直接install的时候就自动包含了flask

卸载包

$ poetry remove foo

会将其从 pyproject.toml 中移除

$ poetry lock

会锁定当前使用的所有依赖的版本，生成一个poetry.lock

poetry shell

poetry env remove python3.7

$ poetry build

会打包当前的py项目，并放到dist目录中

将使用build命令生成的包发布到远程仓库，默认上传至PYPI

$ poetry publish

# 需要输入PYPI的用户名和密码

Username: xxxx

Password: 

Publishing py-sanic-samples (0.1.0) to PyPI

　- Uploading py-sanic-samples-0.1.0.tar.gz 100%

　- Uploading py_sanic_samples-0.1.0-py3-none-any.whl 100%

# 设置 PyPI 镜像源,默认是走的pip的pip.ini设置的来源

[[tool.poetry.source]]

name = "douban"

url = "https://pypi.doubanio.com/simple/"

[tool.poetry.dependencies]

# 使用git仓库：

requests = { git = "https://github.com/requests/requests.git" }

# 使用本地路径：

# directory

my-package = { path = "../my-package/", develop = false }

# file

my-package = { path = "../my-package/dist/my-package-0.1.0.tar.gz" }

# URL

my-package = { url = "https://example.com/my-package-0.1.0.tar.gz" }

[tool.poetry.dependencies]

# python限制：

pathlib2 = { version = "^2.2", python = "~2.7" }

# 指定版本和运行环境

pathlib2 = { version = "^2.2", markers = "python_version ~= '2.7' or sys_platform == 'win32'" }

# 根据py版本来选择版本

foo = [

　　　　{version = "<=1.9", python = "^2.7"},

　　　　{version = "^2.0", python = "^3.4"}

]

# 如果限制很多，也可单独写一个模块

[tool.poetry.group.dev.dependencies.black]

version = "19.10b0"

allow-prereleases = true

python = "^3.6"

markers = "platform_python_implementation == 'CPython'"