使用poetry构建部署在服务器的python项目

使用方法

首先确保本地已经安装了poetry ，

安装方法看：https://www.zhihu.com/question/560649609/answer/2734398975

【1】创建项目

首先创建项目：

poetry init

会多出来一个 pyproject.toml 文件。

如果项目里要使用第三方库，把用到的第三方库写入这个文件中。

项目的名字推荐起名：“人名或你的小团队名 + 项目名缩写”

比如：littlepink-email-system 有一个小粉红做了一个邮件系统

前面加了一个人名或者团队名就是专门为了防止和其他库名给撞了。

然后在项目文件夹下创建一个工程文件夹 ，和刚刚的项目名称一样，只不过连字符改成下划线。

因为python的import语句不能接受连字符。

例如改成 littlepink_email_system

然后再在这个文件夹里创建 __main__.py，这个py文件就是最终启动的地方。必须要有下划线，否则启动的时候会找不到，报错。

所有一切的py工程文件都将放在这个文件夹里。

项目文件夹
	littlepink_email_system
		__main__.py
		...
	README.md
	.git
	dist  # 到时候打包会生成在这个文件夹里
	pyproject.toml

在项目文件夹里还可以创建一些别的文件夹，比如api说明文档之类的。

如果项目中将会使用到第三方库，就编辑toml文件。

[tool.poetry]
name = "项目的名字"
version = "0.1.0"
description = ""
authors = ["某某作者 <作者邮箱@qq.com>"]
readme = "README.md"
packages = [{ include = "项目的名字" }]

[tool.poetry.dependencies]
python = "^3.9"
fastapi = "^0.103.2"
pydantic = "^2.4.2"
mysql-connector-python = "^8.2.0" 
httpx = "^0.25.0"
yagmail = "^0.15.293"
uvicorn = "^0.23.2"
Pillow = "^10.0.1"
cyaron = "^0.5.0"

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

例如上面的数据库中用到了mysql，写上 mysql-connector-python = "^8.2.0"

具体不知道第三方库叫什么名字可以去查查，可以在pycharm的设置里看到，这个太基操了，就先不写了。

项目写的差不多了，想部署在服务器上看看效果：

【2】部署

在项目文件夹下输入指令

poetry build

然后会生成两个文件到dist文件夹下。

然后将dist文件夹下的whl文件上传到linux服务器的一个项目文件夹里。

然后在linux服务器上输入指令

pip install littlepink_email_system-0.1.0-py3-none-any.whl -U

如果太慢了可以换源，换成这样的指令：

pip install littlepink_email_system-0.1.0-py3-none-any.whl -U --index-url https://pypi.tuna.tsinghua.edu.cn/simple

【3】运行

安装好了之后直接输入指令运行

python -m littlepink_email_system

这其实就相当于你直接造了个库，然后在服务器上安装了你写的库，直接运行了这个库。

运行别人的poetry构建的py项目

如果是别人做了一个poetry构建的python项目上传到了github上你想运行

首先同上你需要安装poetry，前面写了这里不重复。

输入，安装环境

poetry install

然后

python -m littlepink_email_system

运行。