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. Documentation, including installation instructions are provided 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.6.0.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

scriptengine-0.6.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.6.0.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.8

File hashes

Hashes for scriptengine-0.6.0.tar.gz
Algorithm Hash digest
SHA256 ad18bc0136cb4d4c022b0aa2963fdf54cb3104b334f385606d0051ce26b322c5
MD5 676bf064a1361edaa82595746f0794dc
BLAKE2b-256 2c0687ceab5f05e501c3804d291e99760851a752adb733caae26a344a7faa877

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 39.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.8

File hashes

Hashes for scriptengine-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 efe3c57e5e70c1e64eb25c87c4bef028805e22d0d01476aae191f9861c600c9b
MD5 587a50264ab370d0259399a30e61a17f
BLAKE2b-256 3d3f942ab83825e6c40e72af6e22edcf497b4bf5863603dd81fadc0aaf0d5394

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