Skip to main content

A utility for building jetpack templates.

Project description

A jetpack template (pack) is just a template for a package.

A pack could be a…

…really just any directory containing subdirectories and template files.

Packs are stored in a hanger and rendered by the jetpack utility.

the Hanger

A simple hanger might look like this:

hanger/
  pack1/
    profile.md
    pack.json
  pack2/
    bio.txt
  pack.cfg
  pack.json

Each pack has it’s own directory in the hanger and contains all the subdirectories and template files for that pack. Additionally pack.cfg and pack.json files may exist at the hanger and/or pack level.

Template Files

Templates use the mustache template syntax (implemented with pystache).

Partials are relative to the hanger directory.

hanger/pack1/profile.md

# {{team}}
{{first}} {{last}}
{{role}}
## Bio
{{> pack2/bio.txt}}
Created: {{today}}

hanger/pack2/bio.txt

Belichick has extensive authority over the Patriots'...

Context Files

Context is stored in pack.json files.

hanger/pack.json

{
  "team": "New England Patriots"
}

hanger/pack1/pack.json

{
  "first": "Bill",
  "last": "Belichik",
  "role": "coach"
}

Built-in Context

The default context includes the following tags, which can be overwritten in a context file, if desired.

datetime

  • today: %c
  • year: %Y
  • month: %m
  • day: %d
  • hour: %H
  • minute: %M
  • second: %S

Configuration Files

Configuration is stored in pack.cfg files. The following options are available:

A pack object can inherit the templates, contexts, and configurations of other packs. Base classes are separated by a comma.

[class]
base: python,generic

Inheritance

When base classes are specified, templates, contexts, and configurations are inherited in the following order:

  • pack
  • pack bases (recursive)
  • hanger

Circular imports are not permitted.

Set the format of built-in context tags by using the datetime directives.

[datetime]
today: %c
year: %Y
month: %m
day: %d
hour: %H
minute: %M
second: %S

Installation

$ git clone https://github.com/bmweiner/jetpack.git
$ python setup.py install

or

$ pip install jetpack

Usage

jetpack provides a terminal command jetpack:

$ jetpack python -s /path/to/hanger
name: my_package
description: The best package!

try jetpack --help for additional details on usage.

and a python module for interaction:

import jetpack
jetpack.launch(hanger='/path/to/hanger', pack='python', name='my_package',
               description='The best package!')

Example

Fork my hanger to get started. This example demonstrates using…

  • partials to create .gitignore and LICENSE
  • subclasses to render python-flask pack from python pack
  • built-in datetime context

Project details


Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page