Requirements

Operating system

Scrippy runs on Unix-like systems: Linux, BSD and macOS.

Note: Windows is not supported: scrippy-core relies on Unix specific features such as users and groups management (pwd and grp modules).

Python

In practice, a Python 3.11 or later installation is required to use the whole Scrippy framework.

On Debian and derivatives, the following system packages are needed:

sudo apt install python3 python3-pip python3-venv

Python packages

The Python packages required by Scrippy are automatically installed with the Scrippy packages. They are listed here for information purpose only.

Package Dependencies
scrippy coloredlogs, PyYAML
scrippy-core coloredlogs, prettytable, filelock, PyYAML, rich
scrippy-template Jinja2
scrippy-remote paramiko, pysmb
scrippy-snmp pysnmp
scrippy-db psycopg2-binary, mysql-connector-python
scrippy-api requests, PyYAML, openapi-core
scrippy-mail None (standard library only)
scrippy-git GitPython

Some modules also need external tools or services, such as the git command for scrippy-git. These requirements are detailed in each module page.