Installation

Currently, there is no package available on PyPI, and there are no plans to offer one in the near future.

To use this project, you must clone it directly from Github and then install the required dependencies.

tip

Before installation, please ensure you have installed DocsaidKit.

If you have not installed DocsaidKit, please refer to the DocsaidKit Installation Guide.

Installation Steps

1. Clone the project:

   git clone https://github.com/DocsaidLab/DocAligner.git

2. Enter the project directory:

   cd DocAligner

3. Install dependencies:

   pip install setuptools wheel

4. Build the package:

   python setup.py bdist_wheel

5. Install the package:

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

Following these steps, you should be able to successfully install DocAligner.

Once installed, you are ready to use the project.

Test the Installation

You can test whether the installation was successful with the following command:

python -c "import docaligner; print(docaligner.__version__)"
# >>> 0.6.0

If you see a version number similar to 0.6.0, it indicates the installation was successful.