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.0.0rc2.tar.gz (38.5 kB view details)

Uploaded Source

Built Distribution

scriptengine-1.0.0rc2-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file scriptengine-1.0.0rc2.tar.gz.

File metadata

  • Download URL: scriptengine-1.0.0rc2.tar.gz
  • Upload date:
  • Size: 38.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for scriptengine-1.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 be641f8425ae5e6b2a744201025d2831c73d81d269e2bb2713617d428589b34a
MD5 1d0e07bcfee5373da1732a8078de36dc
BLAKE2b-256 79935cda7a0057a8871d192a5a15f11ccf25b1b4b6ff2c7bbe37c49e9c9c9053

See more details on using hashes here.

File details

Details for the file scriptengine-1.0.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for scriptengine-1.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 57ec5f2c9003896cb663c7417aad49522ea56089b07b2765d63ed057826f04bc
MD5 f277685a82ce0319091255676404be79
BLAKE2b-256 db9c5d2bae3135ab3f7b407a142ede8526d78d3e513109d45940fa689d8ac3bc

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