Skip to main content

Mr. Franz Cucaracha will be glad to assist you to the document analysis and processing routine

Project description

Documentation Status codecov CI Main CI Develop PyPI version

cucaracha 🪳

Inspired by Franz Kafka's infamous character, Gregor Samsa — an ordinary man who wakes up to find himself transformed into a cockroach in The Metamorphosis. Here, cucaracha embodies the metaphor of a tireless, sometimes bureaucratic helper working tirelessly in the background. In the digital age, Mr. Cucaracha is here to assist you with the complex and often tedious tasks of document processing and analysis.

Meet Mr. Cucaracha: Your Assistant for Digital Document Processing and Analysis

cucaracha is an open-source library crafted to help with digital document analysis and processing. It provides a toolkit for working with both structured and unstructured data, allowing users to collect, transform, and interpret textual content from various document formats, including PDFs and images.

Key Features

  • Text Extraction: Efficiently retrieve text from PDFs and image files, transforming them into usable data.
  • Content Structuring: Process extracted text into structured formats, aiding in more organized data handling and downstream applications.
  • Context Recognition: Perform contextual analysis to interpret and label document content based on intended usage.

The major objective of this project is to offer an accessible, open-source alternative for processing document files, which provides document processing and analysis algorithms to simplify tasks that would traditionally be time-consuming or challenging to automate.

Why cucaracha?

The name cucaracha reflects the tireless, behind-the-scenes nature of the tool. Like Kafka's transformed character, Mr. Cucaracha deals with the mundanity and bureaucracy often present in document processing tasks. He's designed to tackle these repetitive and complex tasks with minimal oversight, ensuring efficient and structured data extraction without the typical hurdles of document handling.

Getting Started

Check out the full documentation for detailed instructions on how to use, implement, and keep up with updates to cucaracha.

Contributing to cucaracha

We welcome contributions to cucaracha! To get involved, take a look at the open issues and join us in enhancing Mr. Cucaracha's capabilities. Whether you're here to fix bugs, suggest features, or work on documentation, your input is valuable to the project.

Happy document processing with Mr. Cucaracha! 🪳

How to install

A quick to use install is via pip, as follows:

[!NOTE] The installation requires Python 3.9 or higher

pip install cucaracha

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

cucaracha-0.3.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

cucaracha-0.3.0-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file cucaracha-0.3.0.tar.gz.

File metadata

  • Download URL: cucaracha-0.3.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/5.15.0-124-generic

File hashes

Hashes for cucaracha-0.3.0.tar.gz
Algorithm Hash digest
SHA256 769f3aacbb39b6fdcdc25f02db3612927eb5f87ad7543ed6c0a55ad797263a05
MD5 0e8c90c4139ca4ec99795c40a135b7f5
BLAKE2b-256 6f2f83a0d4d08993d9b390e539fbdee02b3c86a0b5eb5e85f5c7fa4c09bf7e36

See more details on using hashes here.

File details

Details for the file cucaracha-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: cucaracha-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/5.15.0-124-generic

File hashes

Hashes for cucaracha-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 937346de4c987b92d9faf18b2709f45904e8d0c53a8019a3f4b1ed84a017cafb
MD5 77d17bb996eb8a12250e4cd60b44830e
BLAKE2b-256 ae60e472b5b29fc096b984ab094e88299f00536354f1aebe600fdec4ec5f97f8

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