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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: scriptengine-0.12.0.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.0.tar.gz
Algorithm Hash digest
SHA256 65d1007eae5c73264bfff43f569192d31de295e4fecfeba75fca9a86c7bd97b1
MD5 8e1c719f9dc0e69452f22551af59e1be
BLAKE2b-256 87bf6981e29a46948d6cc71cb6bda790d0333af0919e462039edd7cd40d0320a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scriptengine-0.12.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58fba1ed4b56a6ba76f6aca14637e37ffebf3f0df1080b4d7be79954c48f5461
MD5 4a2f511cb0409325ef5901c6ff99eded
BLAKE2b-256 fb7179e8ae3132da90c59c4a37066d9aa6f2d71a41f32611e95b950e10795bd6

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