Skip to main content

Installation Guide

This guide will walk you through installing ZerePy and its dependencies.

Installing Poetry​

First, install Poetry for dependency management if you haven't already. Follow the official installation instructions at python-poetry.org.

Installing ZerePy​

  1. Clone the repository:
git clone https://github.com/blorm-network/ZerePy.git
  1. Navigate to the ZerePy directory:
cd zerepy
  1. Install dependencies:
poetry install --no-root

This will create a virtual environment and install all required dependencies.

  1. (Optional) Install server mode
poetry install --extras server

This installs additional dependencies:

  • FastAPI for the REST API
  • Uvicorn for the ASGI server
  • Additional server utilities

Running ZerePy​

  1. Activate the virtual environment:
poetry shell
  1. Run the application:
poetry run python main.py

After starting the application, you'll need to configure your connections and set up your first agent. See the Configuration Guide for next steps.