Okydoky 0.9.6

How it works

It works in the following instructions:

1. When new commits are pushed, GitHub triggers Okydoky post-receive hook.

2. Okydoky downloads tarball archives of pushed commits from GitHub.

3. Tarball archive gets extracted into a temporary directory.

4. Sphinx builds the documentation.

5. When users request the docs using their web browser, Okydoky asks the user to authenticate using GitHub OAuth.

6. If they has the authorization, Okydoky serves a built docs.

How to use

It’s an ordinary Python package. You can install it using easy_install:

$ easy_install Okydoky

This package provides a command line script called okydoky. It’s a web application and also a small web server for itself. It takes a config file <config>.

Config files have to contain some required values like GitHub application key and secret key.

You have to create a GitHub application to use Okydoky. Its Callback URL is very important. Fill it with:

http://<host>/auth/finalize

and replaces <host> with the domain name what you’ll use. And then, add a post-receive hook into your GitHub repository:

http://<host>/

If you make a config file, then run an Okydoky server using okydoky script:

$ okydoky -H 0.0.0.0 -p 8080 yourconfig.py

Lastly, you have to make an initial auth to finish installation. Open http://<host>/ in your web browser and login with GitHub from there.

Configuration

The config file is a normal Python script. It uses Flask’s config system. Read Flask’s docs about config files.

REPOSITORY

The user and repository name e.g. 'crosspop/okydoky'.

CLIENT_ID

The GitHub application’s client key.

CLIENT_SECRET

The GitHub application’s secret key.

SAVE_DIRECTORY

The path of the directory to store data. This directory will store some configured data, tarballs, and built documentations.

SECRET_KEY

The secret key to sign sessions. See Flask’s docs about sessions also.

RECREATE_VIRTUALENV

Creates the new virtualenv for every build. It’s a lot slower than not using this, but instead makes free from side effects related site-packages.

Set any nonzero value e.g. 1, True if you want to recreate the virtualenv everytime.

COMPLETE_HOOK

The callback function (any callable object) which is called when the build has complete. It’s called for each commit, even if it failed.

It takes three positional parameters:

1. (basestring) Commit hash

2. (basestring) Permalink of the docs. It might be 404 if the build failed.

3. (tuple) Triple sys.exc_info() function returns if the build failed. None if the build succeeded.

You can utilize the last argument for printing the error traceback e.g.:

import traceback

def COMPLETE_HOOK(commit_id, permalink, exc_info):
    if exc_info is not None:
        traceback.print_exception(*exc_info)

Special environment variable: OKYDOKY

Okydoky sets the special environment variable named OKYDOKY during its build process. You can determine whether it’s built by Okydoky or not.

For example, you can add some additional requirements only for Okydoky build in setup.py script:

import os
from setuptools import setup

install_requires = ['Flask', 'SQLAlchemy']

if os.environ.get('OKYDOKY'):
    install_requires.extend(['Sphinx', 'sphinxcontrib-httpdomain'])

setup(
    name='YourProject',
    install_requires=install_requires
)

Or conf.py for Sphinx:

import os

if os.environ.get('OKYDOKY'):
    html_theme = 'nature'
else:
    html_theme = 'default'

Open source

Okydoky is written by Hong Minhee for Crosspop. It’s distributed under MIT license, and the source code can be found in the GitHub repository. Check out:

$ git clone git://github.com/crosspop/okydoky.git

Changelog