This is the code used to write, build, test, and deploy my personal website and blog. The code was originally based on a great blog post by @n1ko, but has since diverged from that project quite a bit. If you're looking for his work, you can check that out https://nicolas.perriault.net/code/2012/dead-easy-yet-powerful-static-website-generator-with-flask/. Notable changes from his version: the use of docopt, testing, and python packaging for installation of the sitebuilder script. The javascript and visual design of the site are still almost exactly his.

In the spirit of his generosity and in the hopes it might be useful to others, I'm open sourcing my version of it as well.

This repo is a static website builder/generator implemented in Python using the following tools:

• Flask
• Frozen-Flask.
• docopt
• pytest
• boto

Note: you need a working installation of Python and pip. I've recreated the sitebuilder script as a python package, so you can install it in your virtualenv.

    $ git clone git@github.com/crlane/cameronlane.org.git blog
    $ cd blog
    $ git submodule update --init --recursive
    $ virtualenv --no-site-packages `pwd`/env
    $ source env/bin/activate
    (env)$ pip install -e .

That'll get you up and running. Use sitebuilder -h from the command line for options.

I've customized deployment steps to push directly to an s3 bucket configured to serve my site. It works for me, but YMMV. This area of the code is probably the least generalizable section, so caveat emptor.

Also, see the License section of this document for more information about contents copyright.

sitebuilder

Usage:
    sitebuilder build
    sitebuilder deploy [--delete --dry-run]
    sitebuilder new TITLE [--draft]
    sitebuilder serve [--debug --host=HOST --port=PORT]
    sitebuilder test

Options:
    -D --debug        start the server in debug mode
    -H --host=HOST  start the webserver on the given host [default: 0.0.0.0]
    -p --port=PORT  start the webserver on port NUM [default: 8000]
    --draft
    --delete
    --dry-run

The sitebuilder command is installed in the package and is the entry point into the entire system

To serve the website locally (optionally in DEBUG=True mode):

$ sitebuilder serve --debug
* Running on http://0.0.0.0:8000/
* Restarting with reloader

This is useful when you want to see changes without having to rebuild the whole site.

To build the static website:

$ sitebuilder build

Generated HTML files and assets will go to the ./build/ directory.

To deploy the website

$ sitebuilder deploy

Contents in ./pages (blog posts) are licensed under the terms of the Creative Commons BY-NC-SA license.

All the rest including Python code, templates, CSS & JavaScript is released under the terms of the WTFPL.

• This code won't be maintained for any purpose other than my own needs.