Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhimrazy/receipt-ocr
Efficient OCR engine for receipt image processing using Python, FastAPI, and Tesseract
https://github.com/bhimrazy/receipt-ocr
ocr pytesseract tesseract-ocr
Last synced: about 2 months ago
JSON representation
Efficient OCR engine for receipt image processing using Python, FastAPI, and Tesseract
- Host: GitHub
- URL: https://github.com/bhimrazy/receipt-ocr
- Owner: bhimrazy
- License: mit
- Created: 2023-12-01T04:28:14.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-13T12:03:16.000Z (2 months ago)
- Last Synced: 2024-07-13T13:24:37.469Z (2 months ago)
- Topics: ocr, pytesseract, tesseract-ocr
- Language: Python
- Homepage:
- Size: 22.8 MB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Receipt OCR Engine
This repository hosts a script and a Docker-compose setup for performing Optical Character Recognition (OCR) on receipt images.
## Prerequisites
- Python 3.x
- Docker
- Docker-compose
## Installation
### Clone the repository
```bash
git clone https://github.com/bhimrazy/receipt-ocr.git
cd receipt-ocr
```
### Set up Python environment (if not using Docker)
- Install [tesseract](https://tesseract-ocr.github.io/tessdoc/Installation.html)
```bash
# Create and activate a virtual environment (optional but recommended)
python -m venv venv
source venv/bin/activate # For Windows, use venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
```
## Usage
### Running the script locally
#### `main.py`
The `main.py` script performs OCR on an input image of a receipt.
```bash
python main.py -i images/receipt.jpg
```
Replace `images/receipt.jpg` with the path to your receipt image.
>Please ensure that the image is well-lit and that the edges of the receipt are clearly visible and detectable within the image.
### Using Docker-compose
The repository includes a Docker-compose setup for running the OCR engine as a service.
```bash
docker-compose up
```
Once the service is up and running, you can perform OCR on receipt images by sending a POST request to `http://localhost:8000/ocr/` with the image file.
## API Endpoint
The OCR functionality can be accessed via a FastAPI endpoint:
- **POST** `/ocr/`: Upload a receipt image file to perform OCR. The response will contain the extracted text from the receipt.
Example usage with cURL:
```bash
curl -X 'POST' \
'http://localhost:8000/ocr/' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@images/paper-cash-sell-receipt-vector-23876532.jpg;type=image/jpeg'
```
## Using Gemini
- Gemini Docs:https://ai.google.dev/tutorials/python_quickstart
- LinkedIn Post: https://www.linkedin.com/feed/update/urn:li:activity:7145860319150505984/
## License
This project is licensed under the terms of the MIT license.
## References
- [Automatically OCR’ing Receipts and Scans](https://pyimagesearch.com/2021/10/27/automatically-ocring-receipts-and-scans/)