-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.md
128 lines (100 loc) · 4.7 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<p align="center">
<a href="https://api.white-album.top/">
<img width="200px" src="./app/static/img/mur_cat.png" alt='LickingDogAPI'>
</a>
<br>
<a href="https://github.com/llxlr/LickingDogAPI/actions/workflows/syntax.yml">
<img src="https://github.com/llxlr/LickingDogAPI/actions/workflows/syntax.yml/badge.svg" alt="Check Python Syntax">
</a>
<a href="https://github.com/llxlr/LickingDogAPI/actions/workflows/codeql-analysis.yml">
<img src="https://github.com/llxlr/LickingDogAPI/actions/workflows/codeql-analysis.yml/badge.svg" alt="CodeQL">
</a>
<a href="https://github.com/llxlr/LickingDogAPI/actions/workflows/deploy.yml">
<img src="https://github.com/llxlr/LickingDogAPI/actions/workflows/deploy.yml/badge.svg" alt="Auto Deploy">
</a>
<a href="https://github.com/llxlr/LickingDogAPI/actions/workflows/docker.yml">
<img src="https://github.com/llxlr/LickingDogAPI/actions/workflows/docker.yml/badge.svg" alt="Docker Image">
</a>
<a href="https://github.com/llxlr/LickingDogAPI/actions/workflows/merge.yml">
<img src="https://github.com/llxlr/LickingDogAPI/actions/workflows/merge.yml/badge.svg" alt="Merge Imgbot">
</a>
<br>
<em>Licking Dog API | 舔狗API 🍭 - Made <span style="color:#f03d41">❤</span> by james yang & Powered by <a src="https://fastapi.tiangolo.com/">FastAPI</a></em>
</p>
<blockquote><p align="center">敬我暗恋的人</p></blockquote>
## 项目还在发育~~间歇性瞎写~~，处于不断迭代状态
## 使用
```bash
$ git clone https://github.com/llxlr/LickingDogAPI.git
$ cd LickingDogAPI
$ pip3 install --upgrade pip poetry==1.2.0a1
$ poetry install
$ cp app/conf/.env.example app/.env
$ poetry run uvicorn app.main:app --host 127.0.0.1 --port 8001
```
## 用作 Systemd 服务
```bash
$ sudo cp conf/ldapi.service /etc/systemd/system/ldapi.service
$ sudo nano /etc/systemd/system/ldapi.service # 项目路径改成自己的
```
或者使用`gunicorn`:
将
```
uvicorn main:app --host 127.0.0.1 --port 8001
```
替换为
```
gunicorn main:app -b 127.0.0.1:8001 -w 4 -k uvicorn.workers.UvicornWorker
```
有以下命令：
```bash
$ sudo systemctl daemon-reload #重载所有修改过的配置文件
$ sudo systemctl enable ldapi #设置自动启动
$ sudo systemctl start ldapi #启动服务
$ sudo systemctl stop ldapi #停止服务
$ sudo systemctl restart ldapi #重启服务
$ sudo systemctl status ldapi #查看服务状态
```
## Docker 部署
还没搞明白~~雾~~
```bash
$ sudo docker run -d -p 4444:4444 --shm-size=2g -e TZ=Asia/Shanghai selenium/standalone-chrome
$ sudo mkdir /etc/api/ && sudo cp .env.example /etc/api/.env
$ sudo docker build . -f ./Dockerfile -t ldapi:latest
$ sudo docker run --rm -p 8001:8001 -v /etc/api/.env:/.env -v ./cache:/cache -t llxlr/ldapi:latest #临时调试
$ sudo docker run -d -p 8001:8001 -v /etc/api/.env:/.env -v ./cache:/cache -t llxlr/ldapi:latest #或直接部署
$ sudo docker save -o ./ldapi-v0.0.1.tar llxlr/ldapi:latest #导出镜像
$ sudo docker load --input ./ldapi-latest.tar #导入镜像
$ sudo docker export ldapi-latest > ./ldapi-latest.tar #导出容器
$ sudo docker import ./ldapi-latest.tar ldapi-latest #导入容器
```
```bash
$ sudo docker-compose up -d
```
```bash
$ sudo docker pull llxlr/ldapi:latest
```
### Github Actions自动打包镜像
配置文件是`.github/workflows/docker.yml`，文件里设置了默认打包`main`分支，在项目设置`Secrets`里添加`GH_TOKEN`
```bash
$ sudo docker pull docker.pkg.github.com/llxlr/lickingdogapi/ldapi:latest
$ sudo docker pull docker.pkg.github.com/llxlr/lickingdogapi/ldapi:dev
```
## ~~Github Actions自动部署~~
~~配置文件是`.github/workflows/deploy.yml`，部署脚本是`deploy.sh`，在项目设置`Secrets`里添加`DEPLOY_KEY`，`SSH_PORT`，`SSH_HOST`和`SSH_USERNAME`，分别代表与部署服务器公钥对应的私钥，SSH登录端口(默认22)，主机IP和主机用户名。部署需要自行修改`.env`配置文件，改成自己的信息。~~
## 文档
交互文档: [http://127.0.0.1:8001/v1/docs](http://127.0.0.1:8001/v1/docs)
```
POST: 发送数据
GET: 请求数据
PUT: 更新数据
DELETE: 删除数据
```
## 参考链接
- [FastAPI](https://fastapi.tiangolo.com/)
- [Starlette](https://www.starlette.io/)
- [Uvicorn](https://www.uvicorn.org/)
## 鸣谢
> [PyCharm](https://zh.wikipedia.org/zh-hans/PyCharm) 是一个在各个方面都最大程度地提高开发人员的生产力的 IDE，适合专业 Python 全栈开发。
特别感谢 [JetBrains](https://www.jetbrains.com/?from=LickingDogAPI) 为开源项目提供免费的 [PyCharm](https://www.jetbrains.com/pycharm/?from=LickingDogAPI) 等 IDE 的授权
[<img src=".github/jetbrains.png" width="200px"/>](https://www.jetbrains.com/?from=LickingDogAPI)