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

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],
        exclude_tags=[26, 34],
        per_page=12,
        feed_description="The Ubuntu Blog Feed",
        api=BlogAPI(
            session=session,
            use_image_template=True,
        ),
    )
)

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

6.4.2

Dec 12, 2023

6.4.1

Oct 26, 2023

6.4.0

Jul 8, 2021

6.3.1

Oct 6, 2020

6.3.0

Oct 6, 2020

6.2.6

Oct 1, 2020

6.2.5

Sep 29, 2020

This version

6.2.4

Sep 21, 2020

6.2.3

Aug 21, 2020

6.2.2

Aug 13, 2020

6.2.1

Aug 7, 2020

6.2.0

Aug 7, 2020

6.1.1

Aug 4, 2020

6.1.0

Jul 15, 2020

6.0.0

Jun 24, 2020

5.0.0

Feb 14, 2020

4.0.2

Nov 14, 2019

4.0.1

Nov 7, 2019

4.0.0

Oct 1, 2019

3.1.2

Sep 11, 2019

3.1.1

Sep 11, 2019

3.1.0

Sep 10, 2019

3.0.1

Sep 2, 2019

3.0.0

Aug 30, 2019

2.4.1

Aug 22, 2019

2.4.0

Aug 19, 2019

2.3.0

Aug 13, 2019

2.3.0a1 pre-release

Aug 8, 2019

2.2.1

Aug 1, 2019

2.2.0

Aug 1, 2019

2.1.1

Jul 10, 2019

2.1.0

Jul 4, 2019

2.0.14

Jul 3, 2019

2.0.13

Jul 3, 2019

2.0.12

Jun 28, 2019

2.0.11

Jun 28, 2019

2.0.10

Jun 27, 2019

2.0.9

Jun 25, 2019

2.0.8

Jun 20, 2019

2.0.7

Jun 20, 2019

2.0.6

Jun 20, 2019

2.0.5

Jun 20, 2019

2.0.4

Jun 18, 2019

2.0.3

Jun 18, 2019

2.0.2

Jun 17, 2019

2.0.1

Jun 14, 2019

2.0.0

Jun 13, 2019

1.5.15

May 29, 2019

1.5.14

May 28, 2019

1.5.13

May 24, 2019

1.5.12

May 24, 2019

1.5.11

May 23, 2019

1.5.10

May 17, 2019

1.5.9

May 17, 2019

1.5.8

May 17, 2019

1.5.7

May 16, 2019

1.5.6

May 16, 2019

1.5.5

May 14, 2019

1.5.4

May 14, 2019

1.5.3

May 13, 2019

1.5.2

May 10, 2019

1.5.1

May 9, 2019

1.5.0

May 2, 2019

1.3.5

Apr 25, 2019

1.3.4

Apr 24, 2019

1.3.3

Apr 16, 2019

1.3.2

Apr 8, 2019

1.3.1

Apr 8, 2019

1.3.0

Apr 8, 2019

1.2.0

Apr 2, 2019

1.1.0

Mar 27, 2019

1.0.1

Mar 26, 2019

1.0.0

Mar 22, 2019

0.1.4

Feb 21, 2019

0.1.3

Feb 14, 2019

0.1.2

Feb 14, 2019

0.1.1

Feb 14, 2019

0.1

Feb 14, 2019

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

Uploaded Sep 21, 2020 Source

Built Distribution

canonicalwebteam.blog-6.2.4-py3-none-any.whl (14.4 kB view details)

Uploaded Sep 21, 2020 Python 3

File details

Details for the file canonicalwebteam.blog-6.2.4.tar.gz.

File metadata

Download URL: canonicalwebteam.blog-6.2.4.tar.gz
Upload date: Sep 21, 2020
Size: 12.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.7.9

File hashes

Hashes for canonicalwebteam.blog-6.2.4.tar.gz
Algorithm	Hash digest
SHA256	`c9987410c27d2d90eb834bb736477e261262302690abdbce39cc27df6ea37da9`
MD5	`582b2103fb45a5dab4dab37408b7c9d4`
BLAKE2b-256	`ebe972661dad3a507fa7b53ca77fcee921b46f56bae6e155fc87f9541edb8bb8`

See more details on using hashes here.

File details

Details for the file canonicalwebteam.blog-6.2.4-py3-none-any.whl.

File metadata

Download URL: canonicalwebteam.blog-6.2.4-py3-none-any.whl
Upload date: Sep 21, 2020
Size: 14.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.7.9

File hashes

Hashes for canonicalwebteam.blog-6.2.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`fb20475722fe5eb798ea59778ea38784e6a1eb915c2f9b59ec35f3f3f780863d`
MD5	`5c5f0bf1a22aa06c3fbdfbaeb996a1cb`
BLAKE2b-256	`eece02f984886719e8301b3f41cc028bd5a870f0d672c505619775d2557aca5f`