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.12.7.tar.gz (35.2 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.12.7-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scriptengine-0.12.7.tar.gz
Algorithm Hash digest
SHA256 3de033c996a14bd836d73ff6bb3d4a80352e0555e6a2e94621a531f3457caee5
MD5 1735a27ed9a8754a89275e8812a666aa
BLAKE2b-256 9befee2bdef368c7c63d1d190a6e6960d5195ca9cd6d3d6241a904ab6978b6a6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.12.7-py3-none-any.whl
  • Upload date:
  • Size: 43.3 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.12.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8131907ac49e11791b33d8c8d7838ed72dc7e18d02d64a29952a13d664a90d64
MD5 89a76fb602c9a5657d106782ce9aeb2d
BLAKE2b-256 cd857c8589745dc1f0b468e74df79070c44179479eb3adf61dd7d42ac1d17397

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