shoal 0.3.0

Lazy, Python-first, alternative to make, just, doit, and invoke

shoal

Python function and shell command task runner. Alternative to make, just, doit, and invoke. Used in calcipy

Installation

poetry add shoal

Usage

There are two ways to use shoal, either as a way to organize a set of local tasks or to distribute with a package.

For more example code, see the scripts directory or the tests.

Local Runner

Create a shoals.py file with:

from shoal import shoalling

shoalling()

Then run the file with:

poetry run python shoals.py --task-help

Add additional tasks or import tasks from a third party package (such as calcipy)

Package

Create a <package>/shoals.py file with:

from shoal import shoalling  # noqa: F401

Add the file to your pyproject.toml scripts:

[tool.poetry.scripts]
shoal = "shoal:shoalling"

Then test with:

poetry run shoal --task-help

Project Status

See the Open Issues and/or the CODE_TAG_SUMMARY. For release history, see the CHANGELOG.

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:

• DEVELOPER_GUIDE
• STYLE_GUIDE

Code of Conduct

We follow the Contributor Covenant Code of Conduct.

Open Source Status

We try to reasonably meet most aspects of the "OpenSSF scorecard" from Open Source Insights

Responsible Disclosure

If you have any security issue to report, please contact the project maintainers privately. You can reach us at [e-mail].

License

LICENSE