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-0.14.1.tar.gz (37.4 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.14.1-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.14.1.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for scriptengine-0.14.1.tar.gz
Algorithm Hash digest
SHA256 702576d803f3d41bd38da5d18dcc0c39c68d18fad390ed1b04628c46f8b84a5a
MD5 6fe5614630d21625a2d5cfcad8e82377
BLAKE2b-256 de0812972448c6c27aa4d265d4ad60c19da4285957cf47df59d7f72a0e8e099c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 48.2 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.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d8082e4ac16567f4dc9f518ff1a6bf68357cc5f4abf3e879a9a907d5498aa1f7
MD5 248c000250d9da98738e239eb31ce9cb
BLAKE2b-256 906273705f0c931cb14ff9c97d9b23c11fe84fdce11a6d396adb67c0693ce120

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