Getting Started

Installation

Get EduChain running in minutes. Choose the PyPI package for the latest stable release, clone the repository to hack on the source, or pull the Docker image to run the full test suite instantly.

Option 1: Via PyPI (Recommended)

The simplest way to install EduChain is from the Python Package Index.

educhain.py
pip install educhain-dks

Option 2: Clone the repository

If you want to explore or modify the framework source, clone it from GitHub and set up a virtual environment.

  1. Clone the repository

    educhain.py
    git clone https://github.com/CodeWithDks/EduChain.git
  2. Change into the project directory

    educhain.py
    cd EduChain
  3. Create a virtual environment

    educhain.py
    python -m venv venv
  4. Activate it

    Windows

    educhain.py
    venv\\Scripts\\activate

    Linux / macOS

    educhain.py
    source venv/bin/activate
  5. Install dependencies

    educhain.py
    pip install -r requirements.txt
  6. Create a .env file with your API key

    educhain.py
    OPENAI_API_KEY=your_api_key_here

Option 3: Docker (run the full test suite instantly)

Prefer not to set up Python locally? Pull the pre-built Docker image — running it executes EduChain's full test suite automatically, so you can verify everything works in seconds.

educhain.py
docker pull deepaksingh09/educhain-app

Create a .env file in your current directory first, with OPENAI_API_KEY=your_api_key_here, then run:

educhain.py
docker run --env-file .env deepaksingh09/educhain-app

View the image on Docker Hub