Quickstart

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.

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 at the root of your project and make required updates, or set $SUBFORK_CONFIG_FILE to the path to subfork.yml:

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