canonicalwebteam.blog

Каноническое расширение блога

Это расширение позволяет добавить простой раздел Frontend в приложение Flask. Все статьи извлекаются из Back-Cond WordPress от Canonical через API JSON.

Это расширение обеспечивает план с 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/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 пойманы с помощью видеомагнитофона и сохраняются в качестве светильников в каталоге fixtures . Если API обновляется, все светильники могут быть легко обновлены, просто удалив каталог fixtures и повторно зарегистрировав тесты.

Чтобы сделать это запустить rm -rf fixtures && ./setup.py test .