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

How to run tests?

  • Create a virtual environment
  • Install required python dependencies from test-requirements.txt
  • Activate virtual environment and run python3 -m unittest discover tests

How to lint :

  • To check python lint python3 -m flake8 canonicalwebteam setup.py && python3 -m black --line-length 79 --check canonicalwebteam setup.py
  • To run python reformatting python3 -m flake8 canonicalwebteam setup.py && python3 -m black --line-length 79 canonicalwebteam setup.py

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],
        category_ids=[4877],
        featured_category_ids=[4881],
        per_page=12,
        feed_description="The Ubuntu Blog Feed",
        api=BlogAPI(
            session=session,
            use_image_template=True,
            thumbnail_width=330,
            thumbnail_height=185,
        ),
    )
)

category_ids scopes the whole blog to one or more categories: it is ANDed into every query, including article detail and related articles, so a post outside it returns 404.

featured_category_ids is ORed into the featured articles query only. Use it to surface pinned posts from a category the site does not otherwise carry — for example ubuntu.com/blog featuring pinned announcements. Because the main article list keeps the narrower category_ids scope, such a post leaves the page once a newer pinned post displaces it from the featured panel, rather than descending into the list.

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.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (7.4.0)

6 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for anthonydillon from gravatar.com anthonydillon Avatar for canonical-webteam from gravatar.com canonical-webteam Avatar for jkfran from gravatar.com jkfran
+3 more Avatar for jpmartinspt from gravatar.com jpmartinspt Avatar for nottrobin from gravatar.com nottrobin Avatar for tbmb from gravatar.com tbmb

Credits

Author: Canonical webteam

Report project as malware

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-7.3.0.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

canonicalwebteam_blog-7.3.0-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: canonicalwebteam_blog-7.3.0.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for canonicalwebteam_blog-7.3.0.tar.gz
Algorithm Hash digest
SHA256 903288f102dffd834cae8fc8f71dde9aa37fb66a426d8a0c03e8c04feba3ba47
MD5 a6caf637fc3a766b6364755e980c780e
BLAKE2b-256 a588270ebb5654c0b11376c2c6cf39a8d95e2906ab7e8d3c9e97063edbaa864c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for canonicalwebteam_blog-7.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5281490e701ec2d4fec30cbebe2ddef8ab9570edae2781748efddabbb141488
MD5 9bdd97196eb8d7f6e87f29dbcfccc676
BLAKE2b-256 0aaa79ef410332e1df0b306be26377ae2bab92d8c72266201cf65d81e5cee352

See more details on using hashes here.

Release history Release notifications | RSS feed

7.4.0

2 files

7.3.1

2 files

This release

7.3.0 This release

2 files

7.2.0

2 files

7.1.0

2 files

7.0.0

2 files

6.8.4

2 files

6.8.3

2 files

6.8.2

2 files

6.8.1

2 files

6.8.0

2 files

6.7.0

2 files

6.6.0

2 files

6.5.0

2 files

6.4.6

2 files

6.4.5

2 files

6.4.4

3 files

6.4.3

2 files

6.4.2

2 files

6.4.1

2 files

6.4.0

2 files

6.3.1

2 files

6.3.0

2 files

6.2.6

2 files

6.2.5

2 files

6.2.4

2 files

6.2.3

2 files

6.2.2

2 files

6.2.1

2 files

6.2.0

2 files

6.1.1

2 files

6.1.0

2 files

6.0.0

2 files

5.0.0

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.1

2 files

3.0.0

2 files

2.4.1

2 files

2.4.0

2 files

2.3.0

2 files

Pre-release

2.3.0a1

2 files

2.2.1

2 files

2.2.0

2 files

2.1.1

2 files

2.1.0

2 files

2.0.14

2 files

2.0.13

2 files

2.0.12

2 files

2.0.11

2 files

2.0.10

2 files

2.0.9

2 files

2.0.8

2 files

2.0.7

2 files

2.0.6

2 files

2.0.5

2 files

2.0.4

2 files

2.0.3

1 file

2.0.2

1 file

2.0.1

1 file

2.0.0

1 file

1.5.15

1 file

1.5.14

1 file

1.5.13

1 file

1.5.12

1 file

1.5.11

1 file

1.5.10

1 file

1.5.9

1 file

1.5.8

1 file

1.5.7

1 file

1.5.6

1 file

1.5.5

1 file

1.5.4

1 file

1.5.3

1 file

1.5.2

1 file

1.5.1

1 file

1.5.0

1 file

1.3.5

1 file

1.3.4

1 file

1.3.3

1 file

1.3.2

1 file

1.3.1

1 file

1.3.0

1 file

1.2.0

1 file

1.1.0

1 file

1.0.1

1 file

1.0.0

1 file

0.1.4

1 file

0.1.3

1 file

0.1.2

1 file

0.1.1

1 file

0.1

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page