jogger Documentation

The jogger command line utility is a simple Python program that isn’t quite a fully-fledged task runner. In addition to supporting arbitrary tasks, run either directly on the command line or as Python scripts, it ships with some common, useful, Django-aware tasks that can adapt their behaviour based on which packages are available in the system.

A jog.py file is all that is necessary to use jogger, and it can be as simple or as complex as any given project requires.

Contents

• Getting Started
  • Installation
  • Quick start
• Tasks as Strings
  • Usage
  • Default arguments
• Tasks as Functions
  • Usage
  • Using settings
  • Default arguments
• Tasks as Classes
  • Usage
  • Using settings
  • Custom arguments
  • Default arguments
• Config File
  • Defining task settings
  • Accessing task settings
• Controlling Output
  • Styling
• Built-in Tasks
  • Using the built-ins
  • LintTask
  • TestTask
  • DocsTask
  • UpdateTask

API Reference

• Tasks
• Output Utils
• Exceptions