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

Uploaded Source

Built Distribution

scriptengine-0.12.6-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.12.6.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for scriptengine-0.12.6.tar.gz
Algorithm Hash digest
SHA256 440d9c23126daab1e874c803f026e86228b0425dbabb5bddfa60e8c8baf2fe3f
MD5 9bd3ee8d2fce6c09468dc37b47fc3a23
BLAKE2b-256 f178b7e82a78236055c6ca2d4e47f696d5ca41c8ead9c78a99419292fe045b09

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scriptengine-0.12.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5cdf29d28f8e7b83cb555379a0618a4ec1752b111938c851136d7b69ecead066
MD5 82ebbc749dbeca290d5d8acda2459c8d
BLAKE2b-256 d52cf984a3edcf0ba58997d3f92f5a86a0965b38d1110b45d36cd8597f7b5b34

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