fork自https://github.com/wyf9/sleepy
参考自https://github.com/1812z/sleepy
TODOs:
- [] 网页使用 api 请求，并实现定时刷新
- [√] 设备使用状态
- 更好的客户端示例
Are you sleeping?
一个查看个人在线状态的 Flask 网站，让他人能知道你不在而不是故意吊他/她
演示站: Here
理论上全平台通用, 安装了 Python >= 3.6 即可
- Clone 本仓库 (建议先 Fork / Use this template)
git clone https://github.com/wyf9/sleepy.git- 安装依赖
pip install flask- 编辑配置文件
先启动一遍程序:
python3 server.py如果不出意外，会提示: data.json not exist, creating，同时目录下出现 data.json 文件，编辑该文件中的配置后重新启动即可 (示例请 查看 example.jsonc )
有两种启动方式:
- 直接启动
python3 server.py- 简易启动器
python3 start.py相比直接启动, 启动器可在服务器退出后自动重启 (方便开发)
默认服务 http 端口: 9010
| 路径 | 作用 |
|---|---|
/ |
显示主页 |
/query |
获取状态 |
/get/status_list |
获取可用状态列表 |
/set?secret=<secret>&status=<status> |
设置状态 (url 参数) |
/set/<secret>/<status> |
设置状态 (路径) |
/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..
在 _example/ 目录下, 可参考
本项目灵感由 Bilibili UP @WinMEMZ 而来: site / blog, 并部分借鉴使用了前端代码, 在此十分感谢。
感谢 @1812z 的 B 站视频~ (BV1LjB9YjEi3)
如有 Bug / 建议, 请 issue 或 More contact (注明来意).