subfork 0.9.12

Subfork Python API

Subfork Python API

Subfork is the easiest way to build and deploy static sites and micro web apps. This package provides the Subfork Python API and command line interface.

Installation

The easiest way to install:

$ pip install subfork

Requires Python 3.6+.

In order to authenticate with the Subfork API, you will first need to create a site and API access keys for your site at subfork.com.

Quick Start

To use the Subfork Python API you must first complete the configuration steps below. Then instantiate a client using the site domain and access keys:

sf = subfork.get_client()

Configuration

Using the Subfork Python API requires basic authentication. To use environment variables, set the following:

$ export SUBFORK_DOMAIN=<site domain>
$ export SUBFORK_ACCESS_KEY=<access key>
$ export SUBFORK_SECRET_KEY=<secret key>

To use a template file, create a subfork.yml file at the root of your project, or set $SUBFORK_CONFIG_FILE to the path to subfork.yml, and make the required updates:

$ export SUBFORK_CONFIG_FILE=/path/to/subfork.yml

Basic Commands

To create a template file from existing html and static files:

$ subfork create -t <templates folder> -s <static folder>

Be sure to update the values in the new subfork.yml if necessary.

To test the site using the dev server:

$ subfork run

To deploy and release a site:

$ subfork deploy -c "initial deployment" --release

To process queued tasks using workers defined in the template file:

$ subfork worker

Templates

The subfork.yml template file is a config file that contains required auth info, page templates, routes (or endpoints), static files and task workers.

For example, this template contains two routes and a worker:

# enter verified site domain here
domain: ${SUBFORK_DOMAIN}

# enter site credentials here
access_key: ${SUBFORK_ACCESS_KEY}
secret_key: ${SUBFORK_SECRET_KEY}

# path to folder containing template files
# template_folder: templates

# path to static file folder
# static_folder: static

# page template definitions
templates:
  index:
    route: /
    file: index.html
  user:
    route: /user/<username>
    file: user.html

# task worker definitions
workers:
  test:
    queue: test
    function: subfork.worker.test