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

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.3.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

skyr-0.3.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: skyr-0.3.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for skyr-0.3.0.tar.gz
Algorithm Hash digest
SHA256 55475741cd874e0f8c04ed74ca240293b775242c84364fc5801b040e40c2f903
MD5 d8f2e69f5a6424e97e2a04bf9904c487
BLAKE2b-256 8d993e407787aae36ff6b4324078e0d7b9737e2f8abcc776617431e90414fd88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: skyr-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for skyr-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 204b7fe661d641202920698a12611130910c8df2238a2b44af4289fba0a83589
MD5 6842bfae00209175d1c68ca8d774376b
BLAKE2b-256 1903712da0fc2bbc567d5e93d391e20b48f3e5012837688fa76aa2d764c0b5d4

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