Skip to main content

write shell in sh.yml

Project description

Sometimes gnu make reminds me how old I am, shyml makes me feel like a baby again.

Getting started

Install with pip install shyml.

The shyml command will look for a file called sh.yml in the current directory and list the jobs it finds. It will merge them with the default jobs that are in the repository root and open for contributions ;)

Write your sh.yml file as such for example:

---
name: example
color: red          # yes, you can choose the color of your job
requires: other_job # disregard for now, it's for when your sh.yml grows up
script:
- myvar=x
- some
     --super
     --long=$myvar
     line

---
name: setup
hook: before jobs   # this will always execute before any job
script: |
  something cool
env:
  someglobal: foo

You see, we have hooks, choosing colors to jobs (I choose so far: green for non-writing, orange for writing, red for destructive), or doing super long lines of shell commands without backslashes at the end are typically the kind of things that make me feel like a baby again.

Without argument, shyml will just print out all jobs it finds.

With an argument that matches a defined job, it will just output the generated shell script, you can pipe it to a shell if you want to execute it:

shyml                       # lists jobs
shyml jobname               # print a job in bash
shyml jobname | bash -eux   # run a job in a local bash shell

Then you could see your generated bash with shyml example and execute it with shyml example | docker run -it yourcontainer sh or something.

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

shyml-0.7.0.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file shyml-0.7.0.tar.gz.

File metadata

  • Download URL: shyml-0.7.0.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.6

File hashes

Hashes for shyml-0.7.0.tar.gz
Algorithm Hash digest
SHA256 dbc68985c4bf0edec5d38ddce24a46267706878f1d59e569f1bc4e2565998f84
MD5 663009959946926e71eec12240ec2f49
BLAKE2b-256 4348623c4683f745d6339819a6d367804f2c9095f11f491d89c339251cb3607e

See more details on using hashes here.

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