Skip to content

✅ Installation Guide

Why pipx?

pipx installs Python CLI tools in isolated environments, keeping your global Python setup clean while making the command available system-wide.

📦 Install pipx (if not already installed)

brew install pipx
pipx ensurepath

sudo apt update
sudo apt install pipx
pipx ensurepath
sudo pipx ensurepath --global  # Optional: enable global usage

# Using Scoop
scoop install pipx

# Or using pip
python -m pip install --user pipx
python -m pipx ensurepath

python -m pip install --user pipx
python -m pipx ensurepath

✅ Install Escapist with pipx

Install Command

pipx install escapist

🔍 Verify Installation

Run the following to confirm it was installed correctly:

escapist --version

🐍 Alternative: Using pip

Not using pipx?

You can also install Escapist using pip, though it's strongly recommended to use a virtual environment.

pip install escapist

Use a virtual environment

Avoid installing globally with pip. Instead:

python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install escapist

🔄 Upgrading

pipx upgrade escapist

pip install --upgrade escapist

🧹 Uninstalling

pipx uninstall escapist

pip uninstall escapist

🖥️ System Requirements

Requirements

  • Python: 3.8 or higher
  • Operating System: Windows, macOS, Linux
  • Dependencies: Automatically installed during setup