Skip to main content

Flask extension to add a nice blog to your website

Project description

Canonical blog extension

This extension allows you to add a simple frontend section to your flask app. All the articles are pulled from Canonical's Wordpress back-end through the JSON API.

This extension provides a blueprint with 3 routes:

  • "/": that returns the list of articles
  • "/": the article page
  • "/feed": provides a RSS feed for the page.

Installation

To install this extension as a requirement in your project, you can use PIP;

pip3 install canonicalwebteam.blog

See also the documentation for pip install.

Usage

Local development

For local development, it's best to test this module with one of our website projects like ubuntu.com. For more information, follow this guide (internal only).

Templates

The module expects HTML templates at blog/index.html, blog/article.html, blog/blog-card.html, blog/archives.html, blog/upcoming.html and blog/author.html.

An example of these templates can be found at https://github.com/canonical-websites/jp.ubuntu.com/tree/master/templates/blog.

Usage

In your app you can then do the following:

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

You can customise the blog through the following optional arguments:

blog = build_blueprint(
    BlogViews(
        blog_title="Blog",
        blog_path="blog",
        tag_ids=[1, 12, 112],
        excluded_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,
        ),
    )
)

Testing

All tests can be run with ./setup.py test.

Regenerating Fixtures

All API calls are caught with VCR and saved as fixtures in the fixtures directory. If the API updates, all fixtures can easily be updated by just removing the fixtures directory and rerunning the tests.

To do this run rm -rf fixtures && ./setup.py test.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canonicalwebteam_blog-6.4.6.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

canonicalwebteam_blog-6.4.6-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file canonicalwebteam_blog-6.4.6.tar.gz.

File metadata

  • Download URL: canonicalwebteam_blog-6.4.6.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for canonicalwebteam_blog-6.4.6.tar.gz
Algorithm Hash digest
SHA256 731b96bd2785f9cf2be8be3e6cf22f2fec3df925bfb6639863a63223789ba3c2
MD5 b3b83b13df0dcc86f941b79ee432df8d
BLAKE2b-256 5918ebce22b75db95d81ebf724d58ed69361410732c636101f2ff752d80197c9

See more details on using hashes here.

File details

Details for the file canonicalwebteam_blog-6.4.6-py3-none-any.whl.

File metadata

File hashes

Hashes for canonicalwebteam_blog-6.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 389b41a4268edded478fbf03e97510e15e8343d25a2946f7fd3cb7a00cbc2019
MD5 db5a9e204c89f789d8702269b1d144f0
BLAKE2b-256 035f6ed857a8c04870025abd4b4666a5f73a682458b7bee28b5d67f48dd61b34

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page