ruppell 1.0.1

Ruppell is a Python package to help in text extraction from documents.

Ruppell: powerful Python text extractor toolkit

What is it?

Ruppell is a Python wrapper to help in documents' text extraction.

Main Features

Here are just a few of the things that ruppell does well:

• Create datasets from multiple files.
• Extract documents' text (pdf, docx, jpeg, jpg, png).
• Create Pandas dataframe from documents' folder.
• Convert documents to .txt files

Where to get it

Binary installers for the latest released version are available at the Pypi.

pip install ruppell

Requisites

To run Ruppell you need

• Tesseract OCR
• Python >= 3.6

How to use

import ruppell


# Configure your documents language, defaults to eng if not specified!
ruppell.setup_language(language='eng')


# Extract text from pdf
text = ruppell.pdf_to_string(file_path='file_path.pdf')


# Extract text from docx
text = ruppell.docx_to_string(file_path='file_path.docx')


# Extract text from image
text = ruppell.image_to_string(file_path='file_path.jpeg')


# Create pandas dataframe from documents folder
dataframe = ruppell.folder_to_dataframe(folder_path='folder_path')


# Create dict from documents folder
dict_out = ruppell.folder_to_dict(folder_path='folder_path')


# Create .txt files from documents folder
# A folder ./out_{now_in_timestamp} will created in the same path of folder_path
path_to_out = ruppell.folder_to_txt(folder_path='folder_path')

Example

>>> import ruppell
>>> ruppell.image_to_string('image.png')
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer id bibendum sapien.'

Supported Languages

The language codes are ISO 639-2/B or ISO 639-2/T.

All languages codes here.

Contributing

If you think that we can do the Ruppell more powerful please contribute with this project. And let's improve it to help other developers.

Create a pull request or let's talk about something in issues. Thanks a lot.

Author

Jorge Melgarejo, [e-mail]

License

MIT