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

Uploaded Source

Built Distribution

scriptengine-0.12.1-py3-none-any.whl (40.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.12.1.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for scriptengine-0.12.1.tar.gz
Algorithm Hash digest
SHA256 71abbb16f197798bdd4c401d91fb4eecda0167004f536ee19718236ded4ce26c
MD5 74f31df84f9b120f9877ec8b84a9ba20
BLAKE2b-256 55de61b60f42b2538de31c8ed5a26fd794ec2e99f467c31efb2b4ea7148f13a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 40.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for scriptengine-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65c9fa6701bf28563947e742f5514849bc06e8569b350c5d333c1ab31373fb35
MD5 1a67a84828b658fe210636fe51086e2c
BLAKE2b-256 e4a6dae68b4f6b7fcf3b8876660ca5452e683aa1dc4f008c48712e7b5ea1f2cb

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