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

Uploaded Source

Built Distribution

scriptengine-0.7.0-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.7.0.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8

File hashes

Hashes for scriptengine-0.7.0.tar.gz
Algorithm Hash digest
SHA256 1ece9c023584b63f914ecee9f084f2c0a426dcd7ba893eeaa11169e2e193bed7
MD5 6c04983718b3651e224ef06fccaef501
BLAKE2b-256 ba508b15c1dc45c6b23d1c6277470fb2ec8dbb4f55428ecdbe26fb4d521c4d6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.8

File hashes

Hashes for scriptengine-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fbdbc2af712bf9b7b8a7b87b02f1fd9fe4295a12674e2779f433439de724ff07
MD5 ef09f5e3585b03a39a0ec0f5bbbfe011
BLAKE2b-256 a86c1485b24798e6801364fbd1c682729a5b72fe9d1c6cd3f8953a2946b222b5

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