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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-1.0.0rc1.tar.gz
  • Upload date:
  • Size: 39.0 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.0rc1.tar.gz
Algorithm Hash digest
SHA256 ed7959e1c85e5d700fe35617459bf599382cd76cf63bc793690298fdacc4afce
MD5 ea2b087a71e6e88d4c8966d3cfb34d94
BLAKE2b-256 ca9310e25b441ebbe00edf9b60464af1fa55765930dd56bcf9e4ff4a1843cc7f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for scriptengine-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 166fd7d685f86201d47322aae93b3ce5fa59470a388df662e347532748a840f7
MD5 d4e01d04c733470d1611e99ef32ccfc1
BLAKE2b-256 745d6893492f8eecef98d62061ed5a64ee279b0a5a0a55ca52faeccbedb3b851

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