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

Uploaded Source

Built Distribution

scriptengine-0.8.4-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.8.4.tar.gz
  • Upload date:
  • Size: 31.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for scriptengine-0.8.4.tar.gz
Algorithm Hash digest
SHA256 b26332f482ec14dcfb23a0ee4b31534619a1d275e383dd4fec8a3224b89b36f4
MD5 03286e3c195dfcf6fd357baf8549b373
BLAKE2b-256 6775e0f5c3fb6e8060dd3e8ad321b557cfcde531958eb6bb98ff05c22e542595

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.8.4-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for scriptengine-0.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fdf21e00c21e5399944b506492909192c55401ca4b046d6efa28b18c81e29c44
MD5 fa9c856dc0de7c872681a36e4a307c39
BLAKE2b-256 976e30dbdc845860df917565a8de7649c3e609c66fe2106375717462e23c327a

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