Kraken Logo

Kraken Engine

DocumentationGuidesShowcaseCommunity
Ctrl
K
Installation
Creating a Window

Built bydurkisneer1.Kraken Engine is open source and available onGitHub.

  1. Guides
  2. Getting Started
  3. Installation

Installation

Step-by-step instructions to install Kraken Engine on your system.

Before starting, ensure you have a Python version installed that is supported by Kraken Engine, which is Python 3.12 and above.

Create a Virtual Environment

This step is optional and you can skip to installation if you wish. Using a virtual environment helps keep project dependencies isolated.

On Linux:

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

On Windows (PowerShell):

python -m venv .venv
.venv\Scripts\Activate.ps1

Install via PyPI

To get started, install Kraken Engine from PyPI.

1
Download and Install From PyPI

Use the command for your operating system:

# Windows and Linux
pip install kraken-engine

# macOS
pip3 install kraken-engine
2
Import Module Into an Editor

After installing, import the module into a code editor as pykraken:

import pykraken
# Or the recommended way -> import pykraken as kn

You're now ready to start writing your first Kraken script!

Updating

To update Kraken Engine to the latest version, use the following command:

# Windows and Linux
pip install --upgrade kraken-engine

# macOS
pip3 install --upgrade kraken-engine
NextCreating a Window

On this page

Create a Virtual EnvironmentInstall via PyPIUpdating