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(filename=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.5.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

TextSpitter-0.3.5-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: TextSpitter-0.3.5.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for TextSpitter-0.3.5.tar.gz
Algorithm Hash digest
SHA256 e4e2852dae51ae77b6718a62be8fec773d567bec674536ae7011b9c1571aa595
MD5 ed3b0cdf956a9ccd000e1bf8984358a9
BLAKE2b-256 d7bb1af5a3bc78e4f4dff2ce8c87d3e06cdb43a0eb507dcfa847305c569cc789

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: TextSpitter-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for TextSpitter-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c3f10c0b5be26856f7e08d35435559af66cbcc02c4fa1dfa4124cecd6d9a5c54
MD5 d1f371bcc7c376cbf4f9d8b36ccc0913
BLAKE2b-256 fa8f5916f11a79d4ebb358952bf26a4acd6ae5321b3f005ddb5315699efbe84e

See more details on using hashes here.

Provenance

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