Skip to main content

Installation

Before installing Capybara, make sure your system meets the following requirements:

Prerequisites

Ensure that Python 3.10 or higher is installed on your system before proceeding with the installation.

We developed this based on the Ubuntu operating system, so the following instructions may not apply to Windows and MacOS users.

Next, open your terminal and run the following command to install dependencies:

sudo apt install libturbojpeg exiftool ffmpeg libheif-dev

pdf2image Dependencies

pdf2image is a Python module used to convert PDF files into images.

Follow the instructions below to install it based on your operating system:

  • Alternatively, refer to the open-source project pdf2image for installation guides.

Most Linux distributions come pre-installed with pdftoppm and pdftocairo.

If not installed, use your package manager to install poppler-utils:

sudo apt install poppler-utils

Installing the Package

Once the prerequisites are met, you can install the package via git clone:

  1. Clone the repository:

    git clone https://github.com/DocsaidLab/Capybara.git
  2. Install the wheel package:

    pip install wheel
  3. Build the wheel file:

    cd Capybara
    python setup.py bdist_wheel
  4. Install the built wheel package:

    pip install dist/capybara-*-py3-none-any.whl

Frequently Asked Questions

  1. Why is there no Windows version?

    For the love of life, stay away from Windows.

  2. I just want to use Windows, and I prefer you not to meddle!

    Fine, we suggest installing Docker and then using the methods above to run your program via Docker.

    Please refer to the next section: Advanced Installation.

  3. How do I install Docker?

    It's not difficult, but there are a few steps.

    Please refer to the Docker Official Documentation for installation instructions.