Skip to main content

A lightweight and extensible framework for executing scripts written in YAML

Project description

ScriptEngine

Tests Test coverage PyPI package Conda-forge package

ScriptEngine is a lightweight and extensible framework for executing scripts written in YAML. The main purpose of ScriptEngine is to replace shell scripts in situations where highly configurable and modular scripts are needed. ScriptEngine relies on YAML and makes extensive use of Jinja2 templating to provide a comprehensive scripting language. This allows users to put focus on the description of tasks, rather than their implementation. The description of complex tasks should be nearly as short and clear as for simpler ones.

The ScriptEngine concept separates scripts (what to do) from the implementation of tasks (how to do things), and also from the actual execution environment (the script engine instances). This modularity allows the provision of different execution models (e.g. sequential or parallel; local or remote) within the same framework.

ScriptEngine provides a concise set of basic tasks that users can use to write their scripts. However, extensibility is a fundamental principle for ScriptEngine. Complementary task sets are provided as Python packages that can be loaded into ScriptEngine at run time. Thus, the capabilities of ScriptEngine scripts is only limited by available task sets.

ScriptEngine tasks are simple Python classes with a run() method, which means that it is rather easy to build new tasks sets for particular needs. And because everything is based on Python3, there is a wide range of modules available to get the actual work done easily and efficiently.

ScriptEngine is open source software, hosted at GitHub. Up-to-date ScriptEngine packages are provided at PyPI and conda-forge, so installation is as easy as pip install scriptengine or conda install scriptengine. Documentation, including more detailed installation instructions, is published at ReadtheDocs.

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

scriptengine-1.2.0.tar.gz (39.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scriptengine-1.2.0-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

Details for the file scriptengine-1.2.0.tar.gz.

File metadata

  • Download URL: scriptengine-1.2.0.tar.gz
  • Upload date:
  • Size: 39.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scriptengine-1.2.0.tar.gz
Algorithm Hash digest
SHA256 78f7a41c7cfdd79d5488b5a186c5244b7cc02c0cd58c3a21b710786870b54468
MD5 26b06bf918f718f3d7f8e47956c188bc
BLAKE2b-256 540449cdc19e63bb8b4bd47766c7f8f022cdf0a917a3edf88a563f20d28aa946

See more details on using hashes here.

File details

Details for the file scriptengine-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: scriptengine-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 49.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scriptengine-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87d835d2640f4761bede8aed45f55bbfc836ee9b0c986a0a5c8c439b8dc860bb
MD5 b3d5f1d61175f874b047cf5215574b78
BLAKE2b-256 19ee10f033827e73bee54c937f6b272f48b4739f36d335e3721a5d13398f124f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page