Skip to content

Installation

Requirements

  • Python 3.10 or higher
  • pip package manager

Basic Installation

Install the core ebk package:

pip install ebk

Installation with Optional Features

Web Dashboard

pip install ebk[streamlit]

Visualization Tools

pip install ebk[viz]

All Features

pip install ebk[all]

Development Installation

pip install ebk[dev]

Installing from Source

  1. Clone the repository: 

    git clone https://github.com/queelius/ebk.git
cd ebk

  2. Create a virtual environment (recommended): 

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install in development mode: 

    pip install -e ".[dev]"

Using the Makefile

The project includes a Makefile for common development tasks:

# Set up complete development environment
make setup

# Run tests
make test

# Check code coverage
make test-coverage

# Format code
make format

# Run linting
make lint

Verifying Installation

Check that ebk is installed correctly:

ebk --version
ebk --help

Next Steps