An open API service indexing awesome lists of open source software.

https://github.com/sandeepbalachandran/pytheract

Tool for extracting data from files.
https://github.com/sandeepbalachandran/pytheract

extract-data extract-data-from-image pytesseract pytheract tesseract

Last synced: over 1 year ago
JSON representation

Tool for extracting data from files.

Awesome Lists containing this project

README

          

![](./images/preview.png)

Pytheract




GitHub release


GitHub last commit



GitHub commit activity


GitHub issues


GitHub pull requests



GitHub contributors



ESLint



ESLint



ESLint


Codesize


Top Language




Optical character recognition using tesseract

# Table of contents

- [Introduction](#introduction)
- [Usage](#usage)
- [Installation](#installation)
- [Features to include (Help needed)](#features)
- [Contribute](#contribute)

# Introduction

An application that extract meaningful data from any type of files.

# Usage
*For **end users**.*

Currently in progress to set up an environment

- - - -
### Flow
* Upload a file using the frontend.
* Tesseract will extract the texts available in the file uploaded.

- - - -

# Installation
*For **developers**.*
### Prerequisites

The application has a number of dependencies. Kindly ensure you have the following installed on your machine:

- [ ] Python
- [ ] Python packages (Complete details provided below)
- [ ] Mongo
- [ ] Mongodb compass(optional , alternatives available)
- [ ] Tesseract
- [ ] Git

- - - -
- Python
- [Official download.](https://www.python.org/downloads/)

- Tesseract
- [Offcial documentation.](https://github.com/tesseract-ocr/tessdoc/blob/master/Documentation.md)
- [Offcial download section.](https://github.com/tesseract-ocr/tessdoc/blob/master/Downloads.md)
- [V5 alpha using in dev machine.](https://digi.bib.uni-mannheim.de/tesseract/tesseract-ocr-w64-setup-v5.0.0-alpha.20200328.exe)

- Mongo
- [Official download.](https://www.mongodb.com/try/download/community)

- Compass
- [Official download.](https://docs.mongodb.com/compass/master/install)

- Git
- [Official download.](https://git-scm.com/downloads)

- - - -


### Running the Application

1. Install Python if it is not installed already. Add the environment variables and check version.

```cmd
C:\Users\username> python
Python 3.8.5 (tags/v3.8.5:580fbb0, Jul 20 2020, 15:43:08) [MSC v.1926 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
```
2. Install Mongodb if it is not installed already.
3. Install Mongodb compass. ( Client )
4. Go to Mongo db bin folder and run the server

```cmd
C:\Program Files\MongoDB\Server\4.4\bin> mongod
```
It will be available in port 27017

5. Go to compass get in to the db

```cmd
mongodb://localhost:27017
```
6. Install Tesseract

7. Clone the repository

```cmd
git clone https://github.com/SandeepBalachandran/Pytheract.git
```
8. Check into the cloned repository

```cmd
cd Pytheract
```
9. If you are using Pipenv, setup the virtual environment and start it as follows:

```cmd
pipenv install
```

10. Run Flask

```cmd
set FLASK_APP=app.py
set FLASK_ENV=development
flask run
```

It will be available in port 5000

###
# Features
- [ ] Extraction texts from pdf files.
- [ ] Extraction texts from zip files contains both images and pdf files.
- [ ] Get webcam on UI.
- [ ] Capture image/ extract texts from captured image.
- [ ] Using regex locate specific contents . For eg: Email address, Phone number etc


# Contribute
Please check the [**Contributing Guidelines**](https://github.com/SandeepBalachandran/Pytheract/blob/master/CONTRIBUTING.md) before contributing.