pyaleph

(β˜… 94)

Next generation network of decentralized big data applications. Current connected chains: Ethereum, Solana, Polkadot/Substrate, Cosmos-SDK, NULS.

  • .coveragerc
  • .dockerignore
  • .gitignore
  • .readthedocs.yml
  • alembic.ini
  • AUTHORS.rst
  • CHANGELOG.rst
  • CLAUDE.md
  • code-of-conduct.md
  • justfile
  • LICENSE.txt
  • mypy.ini
  • pyproject.toml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/aleph-im/pyaleph

Downloads the entire project code from GitHub to your computer.

cd pyaleph

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
sudo apt install python3 python3-pip python3-venv build-essential libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev liblz4-dev libgmp-dev libsecp256k1-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
cp deployment/docker-build/config.yml .

Type this command into your terminal and run it.

docker-compose -f deployment/docker-build/docker-compose.yml up -d

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
sudo apt install python3 python3-pip python3-venv build-essential libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev liblz4-dev libgmp-dev libsecp256k1-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

python3 -m virtualenv venv

Runs the Python script (or module).

pip install -e .[testing,docs]

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation