Package Health Score

73 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Explore Similar Packages

redhat
9

Popularity

Small

GitHub Stars: 200
Forks: 206
Contributors: 160

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package canonicalwebteam.blog, we found that it has been starred 200 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Dec 12, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Unrecognized

Security Policy

We found a way for you to contribute to the project! Looks like canonicalwebteam.blog is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 116
Open PR: 38
Last Release: 12 months ago
Last Commit: 1 day ago

Further analysis of the maintenance status of canonicalwebteam.blog based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that canonicalwebteam.blog demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 160
Funding: No

A good and healthy external contribution signal for canonicalwebteam.blog project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like canonicalwebteam.blog is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: Unspecified

Age: 6 years
Latest Release: 12 months ago
Dependencies: 5 Direct
Versions: 78
Maintainers: 6
Wheels: OS Independent

Readme

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

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.

canonicalwebteam.blog dependencies

beautifulsoup4 canonicalwebteam-image-template feedgen flask requests

FAQs

What is canonicalwebteam.blog?

Flask extension to add a nice blog to your website. Visit Snyk Advisor to see a full health score report for canonicalwebteam.blog, including popularity, security, maintenance & community analysis.

Is canonicalwebteam.blog popular?

The python package canonicalwebteam.blog receives a total of 3,057 weekly downloads. As such, canonicalwebteam.blog popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is canonicalwebteam.blog well maintained?

We found indications that canonicalwebteam.blog maintenance is sustainable demonstrating some project activity. We saw a total of 160 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is canonicalwebteam.blog safe to use?

The python package canonicalwebteam.blog was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 12:51 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

canonicalwebteam.blog

Flask extension to add a nice blog to your website For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Canonical blog extension

Installation

Usage

Local development

Templates

Usage

Testing

Regenerating Fixtures

canonicalwebteam.blog dependencies

FAQs

What is canonicalwebteam.blog?

Is canonicalwebteam.blog popular?

Is canonicalwebteam.blog well maintained?

Is canonicalwebteam.blog safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Canonical blog extension

Installation

Usage

Local development

Templates

Usage

Testing

Regenerating Fixtures

canonicalwebteam.blog dependencies

FAQs

What is canonicalwebteam.blog?

Is canonicalwebteam.blog popular?

Is canonicalwebteam.blog well maintained?

Is canonicalwebteam.blog safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues