flask-githubcard
一个 Flask 的拓展程序，通过该程序可以快速在前端页面渲染出指定 github 仓库的相关信息卡片。
快速开始
首先通过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 主题效果如下图
注意
- 由于使用了 github 的 api 在没有进行授权的情况下，唯一 IP 在每小时内限制的访问次数为 60 次，超过 60 次则会报 403, 如果访问频率过高，请前往 github 上授权账号；
- 在国内访问 github 会出现超时的现象，可能会导致网页一直无法打开!
第一次写扩展，主要是为了学习 python 第三库开发以及 push 到 pypi 的流程，代码很垃圾，大佬们留情~~~
1
Select Language