Skip to content

Installation¤

Follow the steps below to install ocred locally.

Create a virtual environment¤

Create and activate a virtual environment

python -m venv env

. env/bin/activate

Install OCRed¤

  • Install Tesseract for your OS and add it to PATH

The installation guide is available here

  • pip magic

OCRed uses modern Python packaging and can be installed using pip -

python -m pip install ocred

Build OCRed from source¤

If you want to develop OCRed, or use its latest commit (!can be unstable!), you might want to install it from the source -

  • Install Tesseract for your OS and add it to PATH

The installation guide is available here

  • Clone this repository
git clone https://github.com/Saransh-cpp/OCRed
  • Change directory
cd OCRed
  • Install the package in editable mode with the "dev" dependencies
python -m pip install -e ".[dev]"

Feel free to read our Contributing Guide for more information on developing OCRed.