Skip to content

Installing Zelos

This guide will walk you through the steps to installing the Zelos package.

Installing Python

Before installing the package, ensure you have Python 3.8 or later. We recommend using Python 3.11 or later for optimal performance.

Install Python

If you don't already have brew, you can install it from here

After installing brew, run: 

brew install [email protected]

For Debian-based distributions (like Ubuntu):

sudo apt update
sudo apt install python3.11

  1. Download the Python installer from the official Python website.

  2. Run the installer. Ensure to check the box that says "Add Python 3.x to PATH" before clicking "Install Now."

Setting Up a Virtual Environment

It's recommended to install to a virtual environment. This helps isolate your project dependencies from your global Python environment. Alternatively, you may use pipx for installing it globally.

Create a virtual environment

python3 -m venv .venv --upgrade-deps
source .venv/bin/activate

python3 -m venv .venv --upgrade-deps
source .venv/bin/activate

python3 -m venv .venv --upgrade-deps
.venv\Scripts\activate

Installing the Zelos Package

Finally, install the zeloscloud package.

python3 -m pip install --extra-index-url https://release.zeloscloud.io/py/simple 'zeloscloud[all] >= 0.0.28'

Alternative Installation Methods

Using pipx

If you prefer to install the package globally, consider using pipx. This allows you to run the package in its isolated environment. Install pipx and then the package:

First follow the install pipx guide.

pipx install --pip-args '--extra-index-url https://release.zeloscloud.io/py/simple' 'zeloscloud[all] >= 0.0.28'

You can also install the package directly using pip. However, this is not recommended for development purposes as it could conflict with other Python projects.

python3 -m pip install --extra-index-url https://release.zeloscloud.io/py/simple 'zeloscloud[all] >= 0.0.28'

Verify!

The zelos package should now be installed. To make sure everything worked, you can run the following command to view the current version 

zelos --version

Success

This should result in output similar to: 

$ zelos --version
zelos, version 0.0.34

Pro Tip

Try running with --help/-h to get additional help! 

zelos --help

You're read to start creating your first project! You can refer to our project creation guide to quickly set things up!

Troubleshooting

Error: No matching distribution found

Fatal error from pip prevented installation. Full pip output in file:
    /path/to/file.log
Some possibly relevant errors from pip install:
    ERROR: Could not find a version that satisfies the requirement zeloscloud>=0.0.XXX (from versions: 0.0.1)
    ERROR: No matching distribution found for zeloscloud>=0.0.XXX
Error installing zeloscloud from spec 'zeloscloud[all]>=0.0.XXX'.
This type of error indicates that pip is unable to communicate with the url (https://release.zeloscloud.io/py/simple) specified in the --extra-index-url argument. Since pip cannot communicate with the url properly, it is unable to find the package hosted there.

Remedy

  • Double check that the URL is correct
  • If using pipx see SSLError section below as pipx can mask the underlying SSL error(s)

Error: SSLError, SSLCertVerificationError

SSL Verification failed when attempting to communicate with https://release.zeloscloud.io/py/simple

WARNING: Retrying (Retry(total=0, connect=None, read=None, redirect=None, status=None)) after connection broken by 'SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1000)'))': /py/simple/zeloscloud/

Could not fetch URL https://release.zeloscloud.io/py/simple/zeloscloud/: There was a problem confirming the ssl certificate: HTTPSConnectionPool(host='release.zeloscloud.io', port=443): Max retries exceeded with url: /py/simple/zeloscloud/ (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1000)'))) - skipping

ERROR: Could not find a version that satisfies the requirement zeloscloud>=0.0.XXX (from versions: 0.0.1)
ERROR: No matching distribution found for zeloscloud>=0.0.XXX

Remedy

  • Pass the argument --trusted-host release.zeloscloud.io to pip

Pro Tip

If using pipx, make sure to keep --extra-index-url and --trusted-host in the same string 

--pip-args='--extra-index-url https://release.zeloscloud.io/py/simple --trusted-host release.zeloscloud.io'

Error: Command Not Found

Keep an eye out for warning logs during install indicating that the install path containing zelos command line tools is not in your PATH environment variable. 

Note: 'path/to/install/location' is not on your PATH environment variable. These apps will not be globally accessible until your PATH is updated. Run `pipx ensurepath` to automatically add it, or manually modify your PATH in your shell's config file (i.e. ~/.bashrc).
Common install directories look like:

  • /usr/local/bin
  • /home/your-user/.local/bin
  • C:\Users\your-user\.local\bin
  • C:\Users\your-user\AppData\Local\Programs\Python\...

Remedy

  • Reference the executables directly i.e. /path/to/install/location/zelos.py
  • cd into /path/to/install/location and then execute the program(s)
  • Add /path/to/install/location/ to your PATH environment variable
    • in your shell or .bashrc: export PATH="/path/to/install/location/:$PATH"