Skip to main content

A low-fat task runner.

Project description

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

Using pipx (recommended)

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 ./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

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

skyr-0.1.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

skyr-0.1.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file skyr-0.1.0.tar.gz.

File metadata

  • Download URL: skyr-0.1.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for skyr-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d9c8e3a68099301f47fae4fde96b76ddf6312a9cd25a4a389225bec562ff6e71
MD5 4982681c1be1ed105980ba5cdce60de1
BLAKE2b-256 ac78e33262b9c986a2796cf5c471ead52911273bda898bab5a93bc7437cff305

See more details on using hashes here.

File details

Details for the file skyr-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: skyr-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for skyr-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e938910ef2aaf76d69a309752feb5037263998c27644bc63247ede774ae7ecae
MD5 b0157dbeb40d5cdcb934cbae8055928d
BLAKE2b-256 9d66a956e066c8e1dc3a47a2358aeae582713318fb9003e45111262446d5fe4c

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