Skip to content

Installation

The Akash Python SDK can be installed using pip, the standard Python package manager.

Requirements

System requirements

  • Python: 3.8 or higher
  • Operating system: Linux, macOS, or Windows
  • Dependencies: Automatically installed with pip

Akash Network compatibility

This SDK is compatible with:

  • Akash Node: v0.38.0, v0.38.1

Install from PyPI

Install the latest stable version from PyPI:

pip install akash

Install a specific version:

pip install akash==0.5.0

Install from source

For development or to get the latest features:

git clone https://github.com/cosmosrescue/akash-py.git
cd akash-py

# Development mode
pip install -e .

pip install git+https://github.com/cosmosrescue/akash-py.git

Verify installation

Test that the installation was successful:

test_installation.py
from akash import AkashClient, AkashWallet

wallet = AkashWallet.generate()
print(f"✅ SDK installed successfully!")
print(f"Test wallet address: {wallet.address}")

Expected output: 

✅ SDK installed successfully!
Test wallet address: akash1k8pnxz7p8t8r9w3n6v9c8x7z5y4w3q2e1r6t5

Dependencies

The SDK automatically installs these required packages:

Package Version Purpose
grpcio ≥1.50.0 RPC client library
grpclib ≥0.4.0 Async gRPC library
protobuf ≥4.21.0 Protocol buffer support
googleapis-common-protos ≥1.57.0 Google API common protobuf types
ecdsa ≥0.18.0 Elliptic curve cryptography
bech32 ≥1.2.0 Address encoding/decoding
requests ≥2.20.0 HTTP client for provider communication
mnemonic ≥0.20 BIP39 mnemonic phrase support
pycryptodome ≥3.15.0 Cryptographic functions
cryptography ≥41.0.0 X.509 certificates and SSL/TLS support
pyyaml ≥5.1.0 YAML parsing for manifest files
websocket-client ≥1.0.0 WebSocket support for streaming logs

Virtual environment

Recommended setup

It's recommended to use a virtual environment to avoid dependency conflicts:

python -m venv akash-env

# On Linux/macOS:
source akash-env/bin/activate

# On Windows:
# akash-env\Scripts\activate

pip install akash

conda create -n akash-env python=3.11
conda activate akash-env

pip install akash

pipenv install akash
pipenv shell

Upgrading

To upgrade to the latest version:

pip install --upgrade akash

Check your installed version:

import akash
print(f"Akash SDK version: {akash.__version__}")

Docker

Use the SDK in a Docker container:

Dockerfile
FROM python:3.11-slim

RUN pip install akash

COPY . /app
WORKDIR /app

CMD ["python", "your_app.py"]

Build and run:

docker build -t akash-app .
docker run -it akash-app

Installation complete!

Continue with the Quick start guide.