canonicalwebteam.blog

Extension de blog canonique

Cette extension vous permet d'ajouter une section frontale simple à votre application FLASK. Tous les articles sont tirés du back-end WordPress de Canonical via l'API JSON.

Cette extension fournit un plan avec 3 itinéraires:

• "/": qui renvoie la liste des articles
• "/": la page de l'article
• "/ Feed": fournit un flux RSS pour la page.

Installation

Pour installer cette extension comme exigence dans votre projet, vous pouvez utiliser PIP;

pip3 install canonicalwebteam.blog

Voir également la documentation de l'installation PIP.

Usage

Développement local

Pour le développement local, il est préférable de tester ce module avec l'un de nos projets de site Web comme ubuntu.com. Pour plus d'informations, suivez ce guide (interne uniquement).

Modèles

Le module s'attend à des modèles HTML sur blog/index.html , blog/article.html , blog/blog-card.html , blog/archives.html , blog/upcoming.html et blog/author.html .

Un exemple de ces modèles se trouve sur https://github.com/canonical-websites/jp.ubuntu.com/tree/master/tremplates/blog.

Usage

Dans votre application, vous pouvez ensuite effectuer ce qui suit:

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

Vous pouvez personnaliser le blog via les arguments facultatifs suivants:

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

Essai

Tous les tests peuvent être exécutés avec ./setup.py test .

Régénération des appareils

Tous les appels API sont capturés avec un magnétoscope et enregistrés en tant que luminaires dans le répertoire fixtures . Si l'API se met à jour, tous les luminaires peuvent facilement être mis à jour en supprimant simplement le répertoire fixtures et en relâchant les tests.

Pour ce faire, exécutez rm -rf fixtures && ./setup.py test .