Skip to main content

A YAML-driven task runner for lazy people

Project description

Yo-runner

Yo is a Yaml-driven task runner for lazy people. When you're coding, you may often need to run a long command many times, but you don't want to do all that typing every time. You don't want to have to remember the options or the flags every time. You could write a Makefile, but they're annoying. Maybe your toolkit provides the functionality, if you want to mess with that. You could use something like gulp or grunt, but that's a lot of overhead. All you really want is something like directory-specific aliases.

That's where yo comes in. All you do is write a yo.yaml that looks something like this:

run: poetry run flask run
serve-docs: python -m http.server --directory docs/_build
docs: 
  - poetry run sphinx-build docs docs/_build | tee docs/build_errors.txt
  - serve-docs
test: poetry run pytest

Now, in that directory you can run yo run to run your app, yo serve-docs to serve your documentation folder, yo docs to build and serve documentation, and yo test to figure out why your stupid program still isn't working. And any arguments you pass to the yo command will be passed through the task.

Yo can handle single commands, sequential lists, and concurrent lists. Every command is run on the shell, so pipes and redirects work. There's also support for environment variables and variables internal to the yo.yaml so that you don't have to type paths more than once. It's lazy all the way down.

See the full documentation for yo at https://OliverSherouse.github.io/yo-runner.

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

yo-runner-0.1.2.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

yo_runner-0.1.2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file yo-runner-0.1.2.tar.gz.

File metadata

  • Download URL: yo-runner-0.1.2.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.11 CPython/3.7.1 Linux/4.15.0-1028-gcp

File hashes

Hashes for yo-runner-0.1.2.tar.gz
Algorithm Hash digest
SHA256 17509b3dd74df33a6c6094daf7d730058160ac8e5657b7bf2a90b5c6b3088bb3
MD5 fe273c69f878e128d94c31e2e7fbed19
BLAKE2b-256 7ddce014e97ce716fab3f665165f401a5d5c112477fee8c876d785e1f6bca6e2

See more details on using hashes here.

File details

Details for the file yo_runner-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: yo_runner-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.11 CPython/3.7.1 Linux/4.15.0-1028-gcp

File hashes

Hashes for yo_runner-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b0ae76f42259ce16c5704fe7b16f84875428c6654acfe6f8377940baa2cbcaa1
MD5 7f1c2e59ec9c8724cbd22577c0e7bd0f
BLAKE2b-256 1a29ecec51977b6d3fc8a3c747283fa6c5ad3148a43159120b6193412aebc893

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