Are you sleeping?
一个查看个人在线状态的 Flask 网站，让他人能知道你不在而不是故意吊他/她
ver:
2.0, configver:2
演示站: Here
网页:
服务器:
↑ 使用的 ssh 工具: WindTerm
理论上全平台通用, 安装了 Python 即可 (开发环境: Debian linux)
- Clone 本仓库 (建议先 Fork)
git clone https://github.com/wyf9/sleepy.git
# or ssh:
# git clone [email protected]:wyf9/sleepy.git- 安装依赖
cd sleepy
./install_lib.sh
# or windows:
# .\install_lib.bat
# 也可自行安装: pip install -r requirements.txt
# 其实只有 FLask (目前)- 编辑配置文件
先启动一遍程序:
python3 server.py如果不出意外，会提示: [Warning] [YYYY-MM-DD hh:mm:ss] data.json not exist, creating，同时目录下出现 data.json 文件，编辑该文件中的配置即可 (示例请 查看 example.jsonc )
有两种启动方式:
- 直接启动
python3 server.py- 简易启动器
python3 start.py相比直接启动, 启动器可实现在服务器退出后自动重启
点击展开
Server path: /mnt/usb16/dev/wyf9/sleepy/server.py
Starting server #1
* Serving Flask app 'server'
* Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment.rUse a production WSGI server instead.
* Running on all addresses (0.0.0.0)
* Running on http://127.0.0.1:9010
* Running on http://192.168.1.20:9010
Press CTRL+C to quit
* Restarting with stat
* Debugger is active!
* Debugger PIN: 114-514-191
^C#1 exited with code 2
waiting 5s
Starting server #2
* Serving Flask app 'server'
* Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
* Running on all addresses (0.0.0.0)
* Running on http://127.0.0.1:9010
* Running on http://192.168.1.20:9010
Press CTRL+C to quit
* Restarting with stat
* Debugger is active!
* Debugger PIN: 114-514-191默认服务 http 端口: 9010
| 路径 | 作用 |
|---|---|
/ |
显示主页 |
/query |
获取状态 |
/get/status_list |
获取可用状态列表 |
/set?secret=<secret>&status=<status> |
设置状态 (url 参数) |
/set/<secret>/<status> |
设置状态 (路径) |
以下是 4 个接口的解释
/query:
获取当前的状态 (无需鉴权)
返回 json:
{
"success": true, // 请求是否成功
"status": 0, // 获取到的状态码
"info": { // 对应状态码的信息
"name": "活着", // 状态名称
"desc": "目前在线，可以通过任何可用的联系方式联系本人。", // 状态描述
"color": "awake"// 状态颜色, 对应 static/style.css 中的 .sleeping .awake 等类
}
}/get/status_list
获取可用状态的列表 (无需鉴权)
返回 json:
[
{
"id": 0, // 索引，取决于配置文件中的有无
"name": "活着", // 状态名称
"desc": "目前在线，可以通过任何可用的联系方式联系本人。", // 状态描述
"color": "awake" // 状态颜色, 对应 static/style.css 中的 .sleeping .awake 等类
},
{
"id": 1,
"name": "似了",
"desc": "睡似了或其他原因不在线，紧急情况请使用电话联系。",
"color": "sleeping"
},
// 以此类推
]就是返回
data.json中的status_list列表
/set?secret=<secret>&status=<status>
设置当前状态
<secret>: 在data.json中配置的secret<status>: 状态码 (int)
返回 json:
// 1. 成功
{
"success": true, // 请求是否成功
"code": "OK", // 返回代码
"set_to": 0 // 设置到的状态码
}
// 2. 失败 - 鉴权失败 (密钥错误)
{
"success": false, // 请求是否成功
"code": "not authorized", // 返回代码
"message": "invaild secret" // 详细信息
}
// 3. 失败 - 请求无效
{
"success": false, // 请求是否成功
"code": "bad request", // 返回代码
"message": "argument 'status' must be a number" // 详细信息
}/set/<secret>/<status>
同上 3., 唯一的不同是 url 格式
本项目灵感由 Bilibili UP @ WinMEMZ 而来: site / blog, 并部分借鉴了前端代码。在此十分感谢。
如有 Bug / 建议, 请 issue.