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.10.0.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

scriptengine-0.10.0-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.10.0.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for scriptengine-0.10.0.tar.gz
Algorithm Hash digest
SHA256 01001cc70d5ca45e378a642f3055c31cff83c5970c088f5dbcd75d6e73a1763a
MD5 b440e34eb4f3fb57dd36312cce08e3d2
BLAKE2b-256 e0093335d33752180e50eac9779de6b80e2b1d778957799a05f39f89fea67e6c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for scriptengine-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f9b761574a1b37817ff1990bcc06cc6a69d3509dea8d4102e0dfbb5c68a5267
MD5 f647f132aeab9b3844853121a2cd6a1a
BLAKE2b-256 0f9db9eb737549010163e717ed7cfe5e7753eac8641f8e4aa0d1f52e7197caf7

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