[MIRROR] Low-fat task runner. https://github.com/kytta/skyr
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Nikita Karamov 1246efb37a
Make Skyr a single file again (#28)
Partially revert #26
2 months ago
.github Migrate to hatch 2 months ago
docs
script Use Hatch in our own Skyr scripts 2 months ago
tests Make Skyr a single file again 2 months ago
.gitignore
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2 months ago
CHANGELOG.md Update CHANGELOG 2 months ago
LICENSE
README.md Update documentation 2 months ago
pyproject.toml Make Skyr a single file again 2 months ago
skyr.py Make Skyr a single file again 2 months ago

README.md

Skyr

Low-fat task runner.

Skyr is a task runner, similar to Make. Just like Make, it can have tasks that depend on each other and are executed only if a file changes. But, unlike Make, Skyr doesn't actually have to be installed on your machine to run. That's because Skyr uses Shell scripts to define build commands and looks for special comments for special features. This means you can very easily integrate Skyr into your existing project.

Install

pipx install skyr

Using plain pip

pip install --user skyr

Drop-in executable

wget "https://raw.githubusercontent.com/kytta/skyr/main/skyr.py"

Usage

For example, to execute script/test:

skyr test

If you don't provide the script name, it will default to build:

skyr  # same as 'skyr build'

By default, Skyr searches for your scripts inside ./.skyr/ and ./script. To change that, use --script-dir:

skyr --script-dir ./dev/ test

Roadmap

  • Basic script running: Run .sh, .bash, .zsh, and other files from the script/ directory.
  • Target dependencies: Run scripts if other depend on them.
  • Dependency age: Run scripts only if the files it depends on changed.
  • Script validation: Check that Skyr understands the scripts it was given.
  • Make mode: Support running very basic Makefiles.
  • Make migration mode: Support migrating from a Makefile to a script/ directory.
  • Just mode: Support running very basic Justfiles.
  • Just migration mode: Support migrating from just to a script/ directory.

Licence

© 2023 Nikita Karamov
Code licensed under the ISC License.


This project is hosted on GitHub: https://github.com/kytta/skyr.git