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.

Check it out all the public datasets and ML models used in this project located at Kaggle - Cucaracha Project

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.6.0.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cucaracha-0.6.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cucaracha-0.6.0.tar.gz
Algorithm Hash digest
SHA256 5199ab3806408cfb19e6d2fca13d5cc332835d655f8c20fc2b2688dbff6d7069
MD5 573d161a5b860274b637d084e530d72b
BLAKE2b-256 a26ffda0f02bbd8dc9156e9085b2b18bb35976ee7fa3ccf1b3892e2d85abdcb5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cucaracha-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eca61337229e678b17a5bd2a703812e9546209498bf1288d8f09aa59c7703b0f
MD5 a0283528d8f68ed50b54331411818849
BLAKE2b-256 10481c96f4821aa9eab5ecb390175a83c2535fbd429e31ed970b98cbf8fb30ec

See more details on using hashes here.

Supported by

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