Getting Started

What is hausse?

hausse is a modular project generator, mainly used to build static websites. It collects files from a source folder, process them using a chosen set of plugins, and write them into an output folder.

Note

Hausse plugin-based behaviour is similar to the NodeJS project Metalsmith.

Hausse is shipped with a fair amount of plugins.

Installation

Hausse is available on PyPI.

pip install hausse

In order to generate static websites, you will probably need additional packages:

• markdown2 for Markdown language processing

• pybars3 for Handlebars templates

Due to the versatility of Hausse, these dependencies are optional and are not automatically installed with it.

Hello world

Let’s build a very simple static website. Write the following into src/index.md.

# My new website

Here some contents

Then, open a Python file and write the following code:

from hausse import Hausse
from hausse.plugins import Markdown

project = Hausse()
project.use(Markdown())
project.build()

This code create a new Hausse project in the current directory, summons the Markdown plugin and triggers the project build, writing the result in dist/index.html.

That’s it ! You now have the basics to build nice static websites.