Installing Python libraries

Overview

The dashboard provides a convenient way to install Python packages directly from the web interface without command-line access.

Navigate to Settings → Python packages to access the package installation screen.

Installing packages

• Enter your package requirements in the textarea, one package name per line
• Optionally, each package can be given a version specifier

Example requirements:

atlassian-python-api
azure-storage-blob==12.28.0

Testing packages

• Before installing, you can verify that packages exist on PyPI by clicking the Test button
• Packages from custom indexes or git repositories will be skipped during testing
• Each package will show its status - whether it was found on PyPI or not

Saving and installing

• Click the Save button to install the packages
• After installation completes, all Zato components (scheduler, server, proxy, dashboard) will be restarted automatically to load the new packages

Custom package indexes

To install packages from a custom index, add the index URL at the top of your requirements using the --extra-index-url directive:

--extra-index-url https://my-index.example.com/simple/
atlassian-python-api
my-private-package==1.0.0

You can also use --index-url to replace the default PyPI index entirely:

--index-url https://my-index.example.com/simple/
my-private-package==1.0.0

For automated deployments, Python packages can be installed via Docker volume mounts.

• Mount a requirements.txt file from host to /opt/hot-deploy/python-reqs/requirements.txt inside the container
• Packages will be installed automatically when the container starts
• If the file does not exist or is empty, no dependencies will be installed

Example requirements.txt file:

atlassian-python-api==4.0.7
azure-storage-blob==12.28.0

Docker command with the mount (note the highlighted line):

sudo docker run --pull=always -it --rm -p 22022:22 -p 8183:8183 -p 11223:11223 -p 17010:17010 \
  --mount type=bind,source=/my/reqs.txt,target=/opt/hot-deploy/python-reqs/requirements.txt \
  --name zato-4.1 zatosource/zato-4.1