Skip to main content

The familar Make / Bash hybrid.

Project description

vanity image

    $ bake, n:
    the s☿rangely familiar task runner.

I love using Makefile for one-off tasks in projects.

The problem with doing this is that you can't use familiar bash–isms when doing so, as GNU Make doesn't use the familiar Bash syntax, nor does it allow for simple ad–hoc use of abritrary scripting languages (e.g. Python).

This project seeks to bridge all of these worlds into a single entrypoint — ideal for cross–language repositories.



Features 'n Things

  • A Bakefile, which looks and feels like the good parts of a Makefile.
  • Except, you can write real bash code!
  • Environment variables are explicitly passed or whitelisted (allowed), not inherinted from the parent shell.
  • Unlike Makefile, either tabs or 4 spaces can be used.
  • Tasks can be run safely and reliably. Rest assured that scripts are executed from the project root (e.g. location of the Bakefile).
  • See advanced example for further, juicy, details.

Installing $ bake

MacOS:

$ brew install kennethreitz/-/bake
==> Installing bake from kennethreitz/-

🍺  /usr/local/Cellar/bake/19-09-16: 1,563 files, 16.7MB, built in 11 seconds

Various Linux Distributions (Python 3.6+):

$ pip3 install bake-cli
Collecting bake-cli

Successfully installed bake-cli-0.2.0 delegator.py-0.1.1 pexpect-4.7.0 ptyprocess-0.6.0

✨🍰✨


$ cat Bakefile

full-install: system-deps install
install: node-deps python-deps
format:
    black .

python-deps: @skip:key=Pipfile.lock
    pipenv install
node-deps: @skip:key=yarn.lock
    yarn install
system-deps: @confirm
    brew install pipenv

python-example:
    #!/usr/bin/env python
    import os
    import sys

    print(os.environ['KEY'])
    print(sys.argv[1:])

dangerous-example: @confirm:secure
    # <insert deploy to production here>
    exit 0

$ bake install

 + Executing 'node-deps':
yarn install v1.17.3
[1/4] 🔍  Resolving packages...
success Already up-to-date.
✨  Done in 0.03s.
 + Executing 'python-deps':
Installing dependencies from Pipfile.lock (2ee04c)…
  🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 8/8 — 00:00:01
 + Done.

$ bake python-example KEY=VALUE 1 2 3

 + Executing 'python-argv':
   VALUE
   ['1', '2', '3']
 + Done.

$ bake dangerous-example

+ Executing '@confirm:secure' ·
   What is 10 times 2?: 7
Aborted.

Advanced Usage Sample

advanced screenshot

Fancy, eh?


This repository has been brought to you, with much joy, by Kenneth Reitz.

kr soul icon

As above, so below.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bake-cli-0.3.1.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

bake_cli-0.3.1-py2.py3-none-any.whl (15.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file bake-cli-0.3.1.tar.gz.

File metadata

  • Download URL: bake-cli-0.3.1.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

File hashes

Hashes for bake-cli-0.3.1.tar.gz
Algorithm Hash digest
SHA256 57872c1e38a8607b56dd653103ccc274fab21f13bda779ec198f8c9724d61962
MD5 f38aeaf56a5770ea0ec29bb10d461a2f
BLAKE2b-256 b4c031fe771b3db044adae64794b8245fa5ea74b22dff6d34425cf80c0b2dc95

See more details on using hashes here.

Provenance

File details

Details for the file bake_cli-0.3.1-py2.py3-none-any.whl.

File metadata

  • Download URL: bake_cli-0.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

File hashes

Hashes for bake_cli-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bc4ab488e719602267b45453090574604c6e225037d67f0c608fef8c67f670f0
MD5 91b06627c7a01eda9629ef961d5197ff
BLAKE2b-256 441a08239d02dbf08bb64be3b9533741a76848438c50954b38c0bc72d4b2fb38

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page