Skip to main content

A simple utility to run user defined commands

Project description

Pearun

A simple utility to run user defined commands.

Inspired by scripts in package.json of npm based projects.

Install package

pip install pearun

Usage

User commands are parsed from Pearunfile which contains simple json dictionary.

It is possible to run inline shell commands or execute whole script files.

With your Pearunfile ready, you can list your commands by:

pearun or pearun --help

Or with -f/--file argument when your Pearunfile is not in your CWD:

pearun -f <path_to_Pearunfile> or pearun --file <path_to_Pearunfile>

To execute your command, simply type its name as an argument:

pearun hello_world

Pearunfile example

{
    "hello_world": "echo \"Hello World!\"",
    "script:default": "./script.sh",
    "script:with_arg": "./script.sh some_arg",
    "boolean": "echo \"TRUE/FALSE\"",
    "pyth": "python -c \"print(1 + 1)\""
}

See examples folder to try this Pearunfile.

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

pearun-0.1.1.tar.gz (3.1 kB view hashes)

Uploaded source

Built Distribution

pearun-0.1.1-py3-none-any.whl (4.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page