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

Uploaded Source

Built Distribution

scriptengine-0.13.0-py3-none-any.whl (43.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scriptengine-0.13.0.tar.gz
Algorithm Hash digest
SHA256 e4411ee7fd6693745c7732330b843411661cd60b621ee930a0d61b32f6cf5182
MD5 656ba8c2431b47178d903a0c180b5ed8
BLAKE2b-256 c1b7aa98f51366e583716691e70c28995c5b28593a618b0cc73dfca3b20fa8a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scriptengine-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57c22f360702332f01d811c06adbb25cef1dfa0bd804a9e047fc15f236eb13b0
MD5 5d652223979d83f90c642def6f6bc5e8
BLAKE2b-256 30c1cf0cffc2a7844659ac0c0c29655e139eb1dd545bad60529558b5e53b8aa7

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