Skip to main content

Python package that spits out text from your document files!

Project description

THANK YOU FOR USING TEXTSPITTER!!

I created this little app to help me process documents from folder sets and batches. Instead of trying to determine each file type and process accordingly, I thought it would be more prudent to read file names and then route text extraction functions accordingly. Also, I was having a really difficult time getting textract/pdftotext to work because of damn Poppler. So instead of troubleshooting that whole process after 6+ hours, I figured this was more time-efficient.

This is my first python module, so I hope I did this well!

Installation

  • Type pip install TextSpitter
  • OPTIONAL type pip install PyMuPDF to install the Python-MuPDF engine for better fidelity with text extraction (i.e.: maintaining correct White Spacing)
    • You will need to follow instructions to ensure that PyMuPDF's dependencies install to your system. There are wheels and binaries available for Windows, Linux, and MacOSX, though if you're on something weird like NetBSD/FreeBSD/specialty linux distros, you may e SOL. Fortunately, CLI options like Yum, Pkgin, Apt-Get and so forth will have packages available straight from the terminal.
    • For detailed instructions, please visit here: https://github.com/rk700/PyMuPDF and maybe give those guys some kudos, because they worked their tails off.

Directions

This module is designed to run as simply as possible. Just provide the file location string data into the argument, and get your text returned to you.

from TextSpitter import TexSpitter as TS
folder_loc = 'foo/bar/'

docx_file = folder_loc + 'file_thing.docx'
pdf_file = folder_loc + 'file_thing.pdf'
text_file = folder_loc + 'file_thing.txt'

doc_tup = (docx_file, pdf_file, text_file)

raw_text_payload = [TS(ele) for ele in doc_tup]
text = '\n'.join(raw_text_payload)
return text

TO DOs

  • spruce up documentation
  • Add stream functionality for s3-based file reading
  • expand functionality to other file types
  • TDB

WANT TO CONTRIBUTE!?

OH MY GOD, PLEASE DO.

Just make a pull request and add whatever you want (or fix whatever you want). I'll review and approve if everything seems good.

Thanks, everyone!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TextSpitter-0.3.2.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

TextSpitter-0.3.2-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file TextSpitter-0.3.2.tar.gz.

File metadata

  • Download URL: TextSpitter-0.3.2.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.3

File hashes

Hashes for TextSpitter-0.3.2.tar.gz
Algorithm Hash digest
SHA256 7381ba6f6111679c10ea1e0cb032f71afe880164f461907f2f72ef3e30dbf9e5
MD5 27dd4b8eecde9df3299aeaf38f1891a2
BLAKE2b-256 a19e2c406d910c352723ce23c9e994a6e0fee0081b8c60ed35b33404a07f8376

See more details on using hashes here.

File details

Details for the file TextSpitter-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: TextSpitter-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.3

File hashes

Hashes for TextSpitter-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 41c49cc275c46ff58f46036af89ba7a18cbfe1234b6287061148f2598af9eb90
MD5 e5dec6daecadb4393d6a3860c6527340
BLAKE2b-256 58e4e7b1a82c2fb7725f16a99de66f916f7665be8887b3a67d57ebd6c065ba57

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page