Welcome to pake’s documentation!

pake is a make-like python build utility where tasks, dependencies and build commands can be expressed entirely in python, similar to ruby rake.

pake supports automatic file/directory change detection when dealing with task inputs and outputs, and also parallel builds.

pake requires python3.5+

Installing

Note: pake is Alpha and likely to change some.

To install the latest release use:

sudo pip3 install python-pake --upgrade

If you want to install the development branch you can use:

sudo pip3 install git+git://github.com/Teriks/pake@develop

Module Doc

• pake package
  • Module Contents
• Submodules
  • Module: pake.graph
  • Module: pake.process
  • Module: pake.util
  • Module: pake.conf
  • Module: pake.returncodes

Guides / Help

• Running Pake
  • Manually specifying pakefile(s)
  • Executing in another directory
  • Running multiple tasks
  • Specifying define values
  • Reading defines from STDIN
  • Environmental variables
  • Command line options
  • Return codes
• Writing Basic Tasks
• Input/Output Name Generators & Globbing
  • Multiple input generators at once
• Change Detection Against Directories
• Exiting Pakefiles Gracefully
  • Calls To exit() inside tasks
  • Stack traces from exit/terminate in tasks
• Adding Tasks Programmatically
• Exceptions Inside Tasks
  • pake.TaskSubprocessException
  • pake.SubpakeException
• Concurrency Inside Tasks
  • Output synchronization with ctx.print & ctx.io.write
  • Output synchronization with ctx.call & ctx.subpake
  • Sub task exceptions
• Manipulating Files / Dirs With pake.FileHelper
  • File / Folder creation methods
  • Copy / Move methods
  • Removal / Clean related methods
• Running Commands / Sub Processes
  • TaskContext.call
  • TaskContext.check_output
  • TaskContext.check_call
  • pake.process module methods
• Running Sub Pakefiles

Module Index

• Module Index