Turn your documents into data!
Parsr, is a minimal-footprint document (image, pdf, docx, eml) cleaning, parsing and extraction toolchain which generates readily available, organized and usable data in JSON, Markdown (MD), CSV/Pandas DF or TXT formats.
It provides analysis, data scientists and developers with clean structured and label-enriched information set for ready-to-use applications ranging from data entry and document analysts automation, archival, and many others.
Currently, Parsr can perform document cleaning, hierarchy regeneration (words, lines, paragraphs), detection of headings, tables, lists, ToCs, page numbers, headers/footers, links, and others. Check out all the features.
Table of Contents
- Table of Contents
- Getting Started - Installation - Usage
- Third Party Licenses
-- The advanced installation guide is available here --
The quickest way to install and run the Parsr API is through the docker image:
docker pull axarev/parsr
If you also wish to install the GUI for sending documents and visualising results:
docker pull axarev/parsr-ui-localhost
Note: Parsr can also be installed bare-metal (not via Docker containers), the procedure for which is documented in the installation guide.
-- The advanced usage guide is available here --
To run the API, issue:
docker run -p 3001:3001 axarev/parsr
To access the python client to Parsr API, issue:
pip install parsr-client
To sample the Jupyter Notebook, using the python client, head over to the jupyter demo.
- To use the GUI tool (the API needs to already be running), issue:
docker run -t -p 8080:80 axarev/parsr-ui-localhost:latest
Refer to the Configuration documentation to interpret the configurable options in the GUI viewer.
All documentation files can be found here.
Please refer to the contribution guidelines.
Third Party Licenses
Third Party Libraries licenses for its dependencies:
- QPDF: Apache http://qpdf.sourceforge.net
- ImageMagick: Apache 2.0 https://imagemagick.org/script/license.php
- Pdfminer.six: MIT https://github.com/pdfminer/pdfminer.six/blob/master/LICENSE
- PDF.js: Apache 2.0 https://github.com/mozilla/pdf.js
- Tesseract: Apache 2.0 https://github.com/tesseract-ocr/tesseract
- Camelot: MIT https://github.com/camelot-dev/camelot
- MuPDF (Optional dependency): AGPL https://mupdf.com/license.html
- Pandoc (Optional dependency): GPL https://github.com/jgm/pandoc