Python package

This package is organized to make it as easy as possible to add new extensions and support the continued growth and coverage of textractplus. For almost all applications, you will just have to do something like this:

import textractplus
text = textractplus.process('path/to/file.extension')

to obtain text from a document. You can also pass keyword arguments to textractplus.process, for example, to use a particular method for parsing a pdf like this:

import textractplus
text = textractplus.process('path/to/a.pdf', method='pdfminer')

or to specify a particular output encoding (input encodings are inferred using chardet):

import textractplus
text = textractplus.process('path/to/file.extension', encoding='ascii')

When the file name has no extension, you specify the file’s extension as an argument to textractplus.process like this:

import textractplus
text = textractplus.process('path/to/file', extension='docx')

Additional options

Some parsers also enable additional options which can be passed in as keyword arguments to the textractplus.process function. Here is a quick table of available options that are available to the different types of parsers:






Specify the language for OCR-ing text with tesseract



Specify the language for OCR-ing text with tesseract



For use when method='tesseract', specify the language



With method='pdftotext' (default), preserve the layout



Specify the language for OCR-ing text with tesseract



Specify the language for OCR-ing text with tesseract

As an example of using these additional options, you can extract text from a Norwegian PDF using Tesseract OCR like this:

text = textractplus.process(

A look under the hood

When textractplus.process('path/to/file.extension') is called, textractplus.process looks for a module called textractplus.parsers.extension_parser that also contains a Parser.

textractplus.parsers.process(filename, input_encoding=None, output_encoding='utf_8', extension=None, **kwargs)[source]

This is the core function used for extracting text. It routes the filename to the appropriate parser and returns the extracted text as a byte-string encoded with encoding.

Importantly, the textractplus.parsers.extension_parser.Parser class must inherit from textractplus.parsers.utils.BaseParser.

Many of the parsers rely on command line utilities to do some of the parsing. For convenience, the textractplus.parsers.utils.ShellParser class includes some convenience methods for streamlining access to the command line.

A few specific examples

There are quite a few parsers included with textractplus. Rather than elaborating all of them, here are a few that demonstrate how parsers work.