Skip to main content

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

Release files for cucaracha 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cucaracha 0.6.0
File Size Uploaded
cucaracha-0.6.0.tar.gz 35.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cucaracha 0.6.0
File Interpreter ABI Platform
cucaracha-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 84.8 kB

Release files / cucaracha-0.6.0.tar.gz

Download URL cucaracha-0.6.0.tar.gz
Size 35.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5199ab3806408cfb19e6d2fca13d5cc332835d655f8c20fc2b2688dbff6d7069
BLAKE2b-256 checksum
How to use checksums
a26ffda0f02bbd8dc9156e9085b2b18bb35976ee7fa3ccf1b3892e2d85abdcb5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.10.12 Linux/5.15.0-130-generic

Release files / cucaracha-0.6.0-py3-none-any.whl

Download URL cucaracha-0.6.0-py3-none-any.whl
Size 49.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eca61337229e678b17a5bd2a703812e9546209498bf1288d8f09aa59c7703b0f
BLAKE2b-256 checksum
How to use checksums
10481c96f4821aa9eab5ecb390175a83c2535fbd429e31ed970b98cbf8fb30ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.10.12 Linux/5.15.0-130-generic

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page