Scrippy installer

This is the Scrippy framework installer.

The scrippy command creates the Scrippy directories, writes the Scrippy main configuration file and installs the Scrippy scripting framework packages with pip. It also uninstalls them.

Requirements

• Python >= 3.11
• Linux, BSD or macOS

Install the Scrippy installer

• In a dedicated virtual environment (recommended, mandatory on externally managed Python environments, see PEP 668)

  python3 -m venv ~/.local/share/scrippy/venv
  ~/.local/share/scrippy/venv/bin/pip install scrippy
  

  Scrippy packages are installed in the same virtual environment as the installer: Run the scrippy command with ~/.local/share/scrippy/venv/bin/scrippy and Scrippy scripts with ~/.local/share/scrippy/venv/bin/python.

• In the user Python environment

  export PATH=${HOME}/.local/bin:${PATH}
  pip install scrippy
  

Configure and install the Scrippy scripting framework with default values

• With configuration confirmation

  scrippy install
  

• Without configuration confirmation

  scrippy install -y
  

Default values:

Any preexisting main configuration file is overwritten. Packages are installed with pip install --upgrade (automatic upgrade/downgrade).

Configure and install the Scrippy scripting framework interactively

scrippy install -i

Each directory and package version is prompted for, with the default value between brackets (press Enter to keep it).

Configure and install the Scrippy scripting framework from custom configuration file

scrippy install -c /path/to/config.yml

-i and -c are mutually exclusive. Both can be combined with -y.

Configuration file example

env:
  confdir: ~/.local/share/scrippy/conf
  datadir: ~/.local/share/scrippy/data
  histdir: ~/.local/share/scrippy/hist
  logdir: ~/.local/share/scrippy/log
  reportdir: ~/.local/share/scrippy/reports
  templatedir: ~/.local/share/scrippy/templates
  tmpdir: ~/.local/share/scrippy/tmp
packages:
  scrippy-core: latest
  scrippy-remote: latest
  scrippy-api: latest
  scrippy-db: latest
  scrippy-mail: latest
  scrippy-git: latest
  scrippy-template: latest
  scrippy-snmp: latest

• Both sections are optional.
• Directories missing from the env section keep their default value.
• Paths may be relative or use ~, they are converted to absolute paths (this also applies to paths entered interactively).
• When defined, the packages section replaces the default package list: only the listed packages are installed.
• Package value is either latest (or empty) or a version number (e.g. 1.10).
• The resulting configuration (including the package list) is saved in the main configuration file and used by scrippy uninstall.

Uninstall the Scrippy scripting framework

scrippy uninstall

The packages listed in the main configuration file are uninstalled, then the main configuration file is deleted. Scrippy directories are kept.

When run as root, a confirmation is asked before uninstalling the system wide installation.

Uninstall the Scrippy scripting framework and delete all Scrippy directories

scrippy uninstall --prune

A confirmation is asked before deleting the Scrippy directories (confdir, datadir, histdir, logdir, reportdir, templatedir, tmpdir) and all their content.

scrippy uninstall does not uninstall the Scrippy installer itself (pip uninstall scrippy) nor delete its virtual environment.

Externally managed Python environments (PEP 668)

On recent operating systems (Debian 12+, Ubuntu 23.04+, ...), the system Python environment is externally managed and pip refuses to install or uninstall packages into it. In such an environment, scrippy install and scrippy uninstall fail with a message explaining the available solutions:

• Recommended: Install Scrippy in a dedicated virtual environment (see Install the Scrippy installer) and run Scrippy scripts with its Python interpreter. For a system wide installation (root):

  python3 -m venv /opt/scrippy/venv
  /opt/scrippy/venv/bin/pip install scrippy
  /opt/scrippy/venv/bin/scrippy install
  

• Or force the installation into the system Python environment (may break Python tools provided by the operating system)

  pip install --break-system-packages scrippy
  scrippy install --break-system-packages
  scrippy uninstall --break-system-packages
  

  The --break-system-packages option only has an effect when the Python environment is externally managed.

Command reference

scrippy install [-i | -c CONFIG] [-y] [--break-system-packages]
scrippy uninstall [-p] [--break-system-packages]