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

Uploaded Source

Built Distribution

scriptengine-0.8.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.8.0.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for scriptengine-0.8.0.tar.gz
Algorithm Hash digest
SHA256 2bd60c0647cc192adff4ee729f3bce4319ec7ee5e82072049b52df9b5065fad3
MD5 b0213a76f33aaf78032c356076d7f355
BLAKE2b-256 c722028ba7954503c90c8bf28bbdd19708d77d2b5a408c48d68d0a440d1d2b4b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for scriptengine-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 01b725d81bd81be51674cc5ee5ec0c8aefe582abacce4d9d21a61daf157a6514
MD5 eb002e36bd5e5ef616bb235651d03ffb
BLAKE2b-256 e5922b96f348caeafc57632c5363e0ccfc7858654319fac1c9304bc9c11fd64b

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