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

Uploaded Source

Built Distribution

scriptengine-0.12.2-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.12.2.tar.gz
  • Upload date:
  • Size: 33.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 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.2.tar.gz
Algorithm Hash digest
SHA256 ec759ebc672fe779ee1bdb38950e9475f44d10b819c1ef8f45250382694278fd
MD5 88307991e62b6afa972de39736a74616
BLAKE2b-256 ee54fde5843f191a02e2c08fe72f3306a0162e303484dad1dc7392421f8f94ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.12.2-py3-none-any.whl
  • Upload date:
  • Size: 40.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fb6c148c8cc0d04f410950f3a9fcf0db6e20bd4c33fe3a613410f61f7a117f3b
MD5 714b03104602376200e6b1efd2a5b164
BLAKE2b-256 8ab66c7b639cd0c51dec2b08ec5116ccae21a8ab01c8c72e40ffc78239b79e23

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