Skip to content

Installation & Setup

EasyApplication is a cross-platform Python library compatible with Python 3.12 through 3.14.

This section describes how to install EasyApplication using the traditional method with pip. It is assumed that you are familiar with Python package management and virtual environments.

Environment Setup optional

We recommend using a virtual environment to isolate dependencies and avoid conflicts with system-wide packages. If any issues arise, you can simply delete and recreate the environment.

Creating and Activating a Virtual Environment:

  • Create a new virtual environment: 
    python3 -m venv venv

  • Activate the environment:

    . venv/bin/activate

    . venv/bin/activate

    . venv/Scripts/activate      # Windows with Unix-like shells
.\venv\Scripts\activate.bat  # Windows with CMD
.\venv\Scripts\activate.ps1  # Windows with PowerShell

  • The terminal should now show (venv), indicating that the virtual environment is active.

Deactivating and Removing the Virtual Environment:

  • Exit the environment: 
    deactivate

  • If this environment is no longer needed, delete it:

    rm -rf venv

    rm -rf venv

    rmdir /s /q venv

Installing from PyPI

EasyApplication is available on PyPI (Python Package Index) and can be installed using pip. To do so, use the following command:

pip install EasyApplication

To install a specific version of EasyApplication, e.g., 1.0.3:

pip install 'EasyApplication==1.0.3'

To upgrade to the latest version:

pip install --upgrade EasyApplication

To upgrade to the latest version and force reinstallation of all dependencies (useful if files are corrupted):

pip install --upgrade --force-reinstall EasyApplication

To check the installed version:

pip show EasyApplication

Installing from GitHub alternative

Installing unreleased versions is generally not recommended but may be useful for testing.

To install EasyApplication from the develop branch of GitHub, for example:

pip install git+https://github.com/easyscience/gui-components@develop

To include extra dependencies (e.g., dev):

pip install 'EasyApplication[dev] @ git+https://github.com/easyscience/gui-components@develop'