Installation

You should install ⚡Actions in a virtual environment. If you’re unfamiliar with Python virtual environments, take a look at this guide. A virtual environment makes it easier to manage different projects, and avoid compatibility issues between dependencies.

Start by creating a virtual environment in your project directory:

python -m venv .env

Activate the virtual environment.

MacOs and Linux

source .env/bin/activate

Windows

.env/Scripts/activate

Now you’re ready to install ⚡Actions with the following command:

pip install giza-actions

Note that you will have also to install Giza CLI to create workspaces and deployments. pipx install giza-cli

Install from source

Install ⚡Actions from source with the following command:

pip install git+https://github.com/gizatechxyz/actions-sdk

This command installs the bleeding edge main version rather than the latest stable version. The main version is useful for staying up-to-date with the latest developments. For instance, if a bug has been fixed since the last official release but a new release hasn’t been rolled out yet. However, this means the main version may not always be stable. We strive to keep the main version operational, and most issues are usually resolved within a few hours or a day. If you run into a problem, please open an Issue so we can fix it even sooner!

Editable install

You will need an editable install if you’d like to:

• Use the main version of the source code.

• Contribute to ⚡Actions and need to test changes in the code.

Clone the repository and install ⚡Actions with the following commands:

git clone https://github.com/gizatechxyz/actions-sdk.git
cd actions-sdk
pip install -e .

These commands will link the folder you cloned the repository to and your Python library paths. Python will now look inside the folder you cloned to in addition to the normal library paths. For example, if your Python packages are typically installed in ~/anaconda3/envs/main/lib/python3.7/site-packages/, Python will also search the folder you cloned to: ~/actions-sdk/.

You must keep the actions-sdk folder if you want to keep using the library.

Now you can easily update your clone to the latest version of ⚡Actions with the following command:

cd ~/actions-sdk/
git pull

Your Python environment will find the main version of ⚡Actions on the next run.