https://github.com/tonyfischetti/sake

A self-documenting build automation tool
https://github.com/tonyfischetti/sake

ansible automation documentation make python yaml

Last synced: about 1 month ago
JSON representation

A self-documenting build automation tool

• Host: GitHub
• URL: https://github.com/tonyfischetti/sake
• Owner: tonyfischetti
• License: mit
• Created: 2013-12-11T23:27:48.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-02-04T17:21:19.000Z (over 4 years ago)
• Last Synced: 2024-07-06T05:40:55.469Z (3 months ago)
• Topics: ansible, automation, documentation, make, python, yaml
• Language: Python
• Homepage:
• Size: 1.74 MB
• Stars: 269
• Watchers: 9
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sake

![sake logo](http://statethatiamin.com/media/sakelogo.png)

[![Build Status](https://travis-ci.org/tonyfischetti/sake.svg?branch=master)](https://travis-ci.org/tonyfischetti/sake)

[![License](https://img.shields.io/pypi/l/master-sake.svg)](https://pypi.python.org/pypi/master-sake/)

### What is it?

Sake is a way to easily design, share, build, and visualize workflows with

intricate interdependencies. Sake is self-documenting because the

instructions for building a project also serve as the documentation of the

project's workflow. The first time it's run, sake will build all of the

components of a project in an order that automatically satisfies all

dependencies. For all subsequent runs, sake will only rebuild the parts

of the project that depend on changed files. This cuts down on unnecessary

re-building and lets the user concentrate on their work rather than memorizing

the order in which commands have to be run.

Sake is free, open source cross-platform software under a very permissive

license (MIT Expat) and is written in Python. Sake is stable.

### 

### Examples

To see an example, check out [this project's webpage](http://tonyfischetti.github.io/sake/)

### Installation

This projects depends on

 - Python 2.7, or 3.5 and above (including 3.8!)

 - The networkx python module

 - the PyYAML python module

 - [Graphviz](http://www.graphviz.org)

Assuming you have python and easy\_install installed, just run

    [sudo] easy_install pip

    [sudo] pip install master-sake

More detailed instructions for installation, including platform specific

directions, are available at this project's [webpage.](http://tonyfischetti.github.io/sake/)

### How do I use it

Again, check out [this project's webpage](http://tonyfischetti.github.io/sake/)

for more detailed information

    

### Support or Contact

If you're having trouble using sake; have a question; or want to contribute,

please email me at [email protected]