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. Up-to-date ScriptEngine packages are provided at PyPI and conda-forge, so installation is as easy as pip install scriptengine or conda 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-1.0.0rc3.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

scriptengine-1.0.0rc3-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file scriptengine-1.0.0rc3.tar.gz.

File metadata

  • Download URL: scriptengine-1.0.0rc3.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for scriptengine-1.0.0rc3.tar.gz
Algorithm Hash digest
SHA256 9ba482a7dcb0ac723f5e607395ef5580dd3d52ae4e2748c9a3f67df104ea7539
MD5 fed6182c488c7e102961e1064f1368c8
BLAKE2b-256 c196cf9d98503b734b30fa1573bb0e8db1b03692a9470b5c26f294e162ed1913

See more details on using hashes here.

File details

Details for the file scriptengine-1.0.0rc3-py3-none-any.whl.

File metadata

File hashes

Hashes for scriptengine-1.0.0rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 ec4adf396b957613461edbd9ac9aa070eddd675fc3c79fe575bc7c24c6742924
MD5 a1d0ce6515d094799416ef133b5b1a91
BLAKE2b-256 39f5823b3ca8dc20039339aa948a939d8a4f213f511f1e03d55fcf147666cc31

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