Skip to content

websauna/websauna.blog

Repository files navigation

This is a Python package for websauna.blog, an addon for Websauna framework. You can use it as a simple blog for your site or as an example of Websaunsa design patterns.

Supported Python versions Latest Version License
ci cov  
  • Markdown based editing
  • Disqus based commenting
  • Post description and meta for Google (SEO), Facebook, Twitter. Sitemap support and Google Article metadata support.
  • Blog post management through Websauna admin interface
  • Drafts (admin only visible) and published posts
  • RSS feed
  • Basic unit and functional test suite

Note that this addon is not intended to be used as is, but more of an example. You most likely want to fork it over and modify for your own needs.

https://github.com/websauna/websauna.blog/raw/master/screenshots/post.png

https://github.com/websauna/websauna.blog/raw/master/screenshots/admin.png

Include addon in your application initializer:

class Initializer(websauna.system.Initializer):

    def include_addons(self):
        """Include this addon in the configuration."""
        self.config.include("websauna.blog")

Example settings:

# Title on blog roll
blog.title = My little Websauna blog

# this is "websauna" part from websaua.disqus.com/embed.js univeral
# embed link
blog.disqus_id = websauna

# The email appearing in RSS feed
# (It is recommended not to use any real email)
blog.rss_feed_email = [email protected]

See nav.html example how to add a link to the blog in your site navigation.

Add RSS feed discovery by customizing site/meta.html template:

{# Misc ``<meta>`` tags in ``<head>``. #}

<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width" />

{% include "blog/rss_head.html" %}

Create migrations for blog post SQL table for your site:

ws-alembic -c myapp/conf/development.ini -x packages=all revision --auto -m "Adding blog content types"

Run migrations:

ws-alembic -c myapp/conf/development.ini -x packages=all upgrade head

Go to admin, start adding blog posts.

Activate the virtual environment of your Websauna application.

Then:

cd blog  # This is the folder with setup.py file
pip install -e .

Example (OSX / Homebrew):

psql create blog_dev
ws-sync-db websauna/blog/conf/development.ini
ws-create-user websauna/blog/conf/development.ini [email protected] mypassword
ws-pserve websauna/blog/conf/development.ini --reload

First create test database:

# Create database used for unit testing
psql create blog_test

Install test and dev dependencies (run in the folder with setup.py):

pip install -e ".[dev,test]"

Run test suite using py.test running:

py.test

Please see https://websauna.org/