scrunkly 0.1.0

A script runner for the modern age.

Scrunkly

Scrunkly is a lightweight Python utility for defining and running scripts through a flexible command-line interface. It allows users to organize commonly used scripts into an easily maintainable dictionary, making script execution and management simpler.

Features

• Script Management: Define scripts in a dictionary and run them via command line.
• Sub-Scripts: Chain scripts together and run them in sequence.
• Error Handling: Detect self-referencing scripts and prevent infinite loops.
• Flexible Scripting: Supports both string-based and callable scripts.

Installation

You can install the required dependencies with pipenv:

pip install scrunkly

Usage

Define your scripts in a dictionary and pass it to scrunkly.scripts. You can map script names to shell commands or Python functions. Sub-scripts are supported, allowing a script to trigger other scripts in the map.

Here's an example usage:

# run.py
from scrunkly import scripts, py

def get_available_port() -> int:
    ...

def instructions():
    ...

scripts({
    "api:prod": f"{py} -m uvicorn api:app --host 0.0.0.0 --port {get_available_port()}",
    "api:dev": f"{py} -m uvicorn api:app --reload",
    "worker": f"{py} worker-runner.py",
    "install": f"{py} -m pipenv install",
    "mongo:dev": "docker run -d --name api-dev -p 27017:27017 mongo",
    "data-import": f"{py} ./scripts/part_data_import.py",
    "setup:dev": ["mongo:dev", "data-import", instructions],
})

Running a Script

You can run a script by providing its name as a command-line argument:

python run.py api:dev

This will execute the corresponding script, such as starting the API in development mode using Uvicorn.

Chaining Scripts

You can chain multiple scripts together using a list of script names. For example, the setup:dev script runs two scripts: mongo:dev and data-import:

python run.py setup:dev

Contributing

Feel free to fork this repository and submit pull requests. Contributions are welcome!

License

This project is licensed under the MIT License.

---

Happy scripting with Scrunkly!