Skip to main content

A lightweight and extensible framework for executing scripts written in YAML

Project description

ScriptEngine

Tests Test coverage PyPI package Conda-forge package

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scriptengine-0.13.1-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.13.1.tar.gz
  • Upload date:
  • Size: 35.5 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.1.tar.gz
Algorithm Hash digest
SHA256 2d4f50d80e5b7ac495cb58836f5ab0adea463cc9a9dc42d0b530797d225a7f58
MD5 51549bad31bfbe314d5df9e592a28371
BLAKE2b-256 1aaececfc9f32ac3424cfc44d695e013fff1cebb92b29cf02ed2f3d802e3b49d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 43.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for scriptengine-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f514b6ea49bc04f8b5f87bf1c7f4d59eaf0fa373cf525d0a545c147282afcd8b
MD5 881bce8db33b8a27042428958c4fc967
BLAKE2b-256 c590497006a9170ed6fabae037d1af056bcb42ed7cbbd5d964878c3aec8461ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page