canonicalwebteam.blog

Extensão do blog canônico

Esta extensão permite adicionar uma seção de front -end simples ao seu aplicativo de frasco. Todos os artigos são retirados do back-end do Canonical WordPress através da API JSON.

Esta extensão fornece um plano com 3 rotas:

• "/": que retorna a lista de artigos
• "/": a página do artigo
• "/Feed": fornece um feed RSS para a página.

Instalação

Para instalar esta extensão como um requisito em seu projeto, você pode usar o PIP;

pip3 install canonicalwebteam.blog

Veja também a documentação para instalação do PIP.

Uso

Desenvolvimento local

Para o desenvolvimento local, é melhor testar este módulo com um de nossos projetos de site como o Ubuntu.com. Para mais informações, siga este guia (somente interno).

Modelos

O módulo espera que os modelos HTML em blog/index.html , blog/article.html , blog/blog-card.html , blog/archives.html , blog/upcoming.html e blog/author.html .

Um exemplo desses modelos pode ser encontrado em https://github.com/canonical-websites/jp.ubuntu.com/tree/master/templates/blog.

Uso

No seu aplicativo, você pode fazer o seguinte:

 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" )

Você pode personalizar o blog através dos seguintes argumentos opcionais:

 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 ,
        ),
    )
)

Teste

Todos os testes podem ser executados com ./setup.py test .

Regeneração de acessórios

Todas as chamadas de API são capturadas com videocassete e salvas como acessórios no diretório fixtures . Se as atualizações da API, todos os acessórios poderão ser facilmente atualizados removendo o diretório fixtures e executando os testes.

Para fazer isso, rm -rf fixtures && ./setup.py test .