canonicalwebteam.blog

规范博客扩展

此扩展程序使您可以在烧瓶应用程序中添加一个简单的前端部分。所有文章均通过JSON API从Canonical的WordPress后端取出。

该扩展名提供了一个带有3个路由的蓝图：

• “/”：返回文章列表
• “/”：文章页面
• “/feed”：为页面提供RSS提要。

安装

要在项目中安装此扩展程序，您可以使用PIP；

pip3 install canonicalwebteam.blog

另请参见PIP安装文档。

用法

地方发展

对于本地开发，最好使用Ubuntu.com等网站项目之一测试该模块。有关更多信息，请遵循本指南（仅内部）。

模板

该模块期望HTML模板在blog/index.html ， blog/article.html ， blog/blog-card.html ， blog/archives.html ， blog/upcoming.html和blog/author.html 。

这些模板的一个示例可以在https://github.com/canonical-websites/jp.ubuntu.com/tree/master/master/templates/blog中找到。

用法

在您的应用中，您可以执行以下操作：

 import flask
import talisker . requests
from flask_reggie import Reggie
from canonicalwebteam . blog import BlogViews , build_blueprint , BlogAPI

app = flask . Flask ( __name__ )
Reggie (). init_app ( app )
session = talisker . requests . get_session ()

blog = build_blueprint (
    BlogViews (
        api = BlogAPI ( session = session ),
    )
)
app . register_blueprint ( blog , url_prefix = "/blog" )

您可以通过以下可选参数自定义博客：

 blog = build_blueprint (
    BlogViews (
        blog_title = "Blog" ,
        blog_path = "blog" ,
        tag_ids = [ 1 , 12 , 112 ],
        exclude_tags = [ 26 , 34 ],
        per_page = 12 ,
        feed_description = "The Ubuntu Blog Feed" ,
        api = BlogAPI (
            session = session ,
            use_image_template = True ,
            thumbnail_width = 330 ,
            thumbnail_height = 185 ,
        ),
    )
)

测试

所有测试都可以使用./setup.py test进行。

再生固定装置

所有API呼叫都被VCR捕获，并保存为fixtures目录。如果API更新，则可以通过删除fixtures目录并重新计算测试来轻松更新所有固定装置。

要执行此运行rm -rf fixtures && ./setup.py test 。