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

Uploaded Source

Built Distribution

scriptengine-0.7.1-py3-none-any.whl (39.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.7.1.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8

File hashes

Hashes for scriptengine-0.7.1.tar.gz
Algorithm Hash digest
SHA256 86e4b40fc5f9bba897597c366787457cdf7a6990c225802b7bf8a7fd1f422af6
MD5 05da2aa4fb254d2aaec95e6a91b3c329
BLAKE2b-256 3aa9f7a07f97945c9c444c64542098b4d03eb95fd926e7764a625e98838c3f9a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 39.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8

File hashes

Hashes for scriptengine-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ee2d6e3cc5ec0a9d7b31a0113a57bcec15650761a8f2058ce51256804bfcc30
MD5 9e9c1aff4fb3dd67020d974b40fbf45e
BLAKE2b-256 27914f74c60f3e250c427bd758ccf9f832d27949219bede1eb8d371ecc212447

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