写了一个 flask 扩展

2021-06-10 17:06:05 +08:00
 Macv1994

flask-githubcard

一个 Flask 的拓展程序,通过该程序可以快速在前端页面渲染出指定 github 仓库的相关信息卡片。

English Document

快速开始

首先通过pip安装依赖程序flask-githubcard

pip install flask-githubcard

初始化扩展

from flask import Flask
from flask_githubcard import GithubCard

app = Flask(__name__)
githubcard = GithubCard(app)

初始化依赖

在你基类模板的<head>块初始化扩展的依赖

{{githubcard.init_css()}}
{{githubcard.init_js()}}

渲染 github 卡片

<div>
    {{githubcard.generate_card()}}
</div>

之后访问你的页面,效果如下

进阶

在使用扩展程序的时候我们可以通过 app.config[some] 来配置,配置项列表如下

配置项 说明 默认 可选
GITHUB_USERNAME 需要展示的 github 用户名 weijiang1994 None
GITHUB_REPO 需要展示的 github 仓库名 Blogin None
theme 渲染主题配色 default default/darkly

同时扩展内置了两款主题,默认的亮色,如果需要改变主题为 darkly 通过下面的代码即可实现

<head>
    {{githubcar.init_css(theme='darkly')}}
</head>
<div>
    {{githubcard.generate_card('darkly')}}
</div>

darkly 主题效果如下图

注意

第一次写扩展,主要是为了学习 python 第三库开发以及 push 到 pypi 的流程,代码很垃圾,大佬们留情~~~

1435 次点击
所在节点    分享创造
5 条回复
johnsona
2021-06-10 18:34:36 +08:00
toy
abersheeran
2021-06-10 18:48:42 +08:00
有个建议,commit 都是中文,你就别开屏 English Document 了。你这么搞,中国人外国人都不待见。

不如直接开屏中文文档,再加个 English 的链接在 README 里。
Macv1994
2021-06-11 09:11:15 +08:00
@abersheeran 嗯,谢谢,上传 pypi 后忘记改回来了。
abersheeran
2021-06-11 10:57:05 +08:00
看了一下源码,还有一个建议。如果你是写 flask 插件,那么只要有生成代码的部分,就可以放心的使用 jinjia2,特别是你这种一大段 HTML 的,更应该用了。
Macv1994
2021-06-11 13:49:09 +08:00
@abersheeran 第一次写没啥经验,感谢建议.

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/782689

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX