adrixop95/pydfocr repository overview

⁠pydfocr service

Serwis written in order to optically recognize characters (ocr) in pdf files and images

⁠Demo

⁠Requirements and dependencies

The website was written using Python 3.8 (or greater) and FastAPI.
The dependencies are listed in the pyproject.toml file.

⁠Installation

By default, the application is served on port 8000.

⁠Local

To run the application locally, install the dependencies using poetry⁠

poetry install

file and then execute the command

uvicorn app.main:app --reload

in the application's root directory.

⁠Docker

Run the container from the available registry.

docker run -p 8000:8000 adrixop95/pydfocr:latest

⁠docker-compose example

To run the application on localhost from docker-compose, go to the deployment/docker-compose folder and execute the command:

Windows:

$env:URL="localhost"; docker-compose -f docker-compose.yml up

Linux, macOS:

URL="localhost" docker-compose -f .\docker-compose.yml up

Traefik automatically manages the SSL certificate generating the let's encrypt certificate. The certificate is generated for [email protected], please change if necessary.

After launch, it will be available at https://localhost/api/v1/⁠

⁠License

The application is available under the GNU GENERAL PUBLIC LICENSE.