Skip to main content

A lightweight and extensible framework for executing scripts written in YAML

Project description

ScriptEngine

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. ScriptEngine packages are provided at PyPI, so installation is as easy as pip 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-0.12.3.tar.gz (33.6 kB view details)

Uploaded Source

Built Distribution

scriptengine-0.12.3-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.12.3.tar.gz
  • Upload date:
  • Size: 33.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for scriptengine-0.12.3.tar.gz
Algorithm Hash digest
SHA256 91a01cd0d627b53dd41ccdb6fb67945ce7bce25e412cc4845b9ac10202a44513
MD5 5d72c85a086e1407e57407ff3ab556f1
BLAKE2b-256 54f75285a5b638e1ade8d7056dbeb0feab4d16da05de7849aedfbac32e2dc847

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.12.3-py3-none-any.whl
  • Upload date:
  • Size: 41.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for scriptengine-0.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ccb91509f09a94d1c376bb22376f40ba90f9add6f251b432bb8b639488f05bf3
MD5 f60c9478da04490e6a5e671b628e250e
BLAKE2b-256 eefb59b1d92192624caa4c4edcea77880d1ce04fccdab538043ce490b2b8cd9b

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