Skip to main content

A Python package for document processing and analysis with LLM integration and OCR capabilities

Project description

AIGrok

AIGrok is an advanced document analysis tool that uses AI to process, analyze, and extract information from documents.

Features

  • 📄 Process multiple document formats (PDF, TXT, etc.)
  • 🤖 Advanced AI-powered analysis with OpenAI and Ollama support
  • 🔍 Smart content extraction with OCR capabilities
  • 💾 Result caching for performance
  • 🛠️ Extensible provider system
  • 📊 Comprehensive reporting
  • 📝 Structured output support
  • 🔄 Automatic model discovery
  • 📈 Code coverage tracking

Quick Start

  1. Install AIGrok:

    pip install aigrok
    
  2. Set up your configuration:

    aigrok config init
    
  3. Process a document:

    aigrok process document.pdf
    

Documentation

For detailed documentation, please see the docs directory:

Requirements

  • Python 3.9+ (including 3.12)
  • One of:
    • Ollama with vision models installed
    • OpenAI API key for GPT-4 Vision
  • 4GB RAM minimum
  • Internet connection for API access

Installation

From PyPI

pip install aigrok

From Source

git clone https://github.com/yourusername/aigrok.git
cd aigrok
pip install -e .

Basic Usage

from aigrok import process_document

# Process a document
result = process_document("document.pdf")
print(result.text)

# Process with custom prompt
result = process_document(
    "document.pdf",
    prompt="Extract main topics",
    model="llama2-vision"
)

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Acknowledgments

  • Thanks to all contributors
  • Built with Ollama
  • Inspired by the need for better document analysis tools
  • 90% of this project was written by AI using Cursor or Windsurf with Anthropic's Claude.

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

aigrok-0.3.2.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

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

aigrok-0.3.2-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aigrok-0.3.2.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for aigrok-0.3.2.tar.gz
Algorithm Hash digest
SHA256 ecc56af79a086a6c09beac5ce52cb46d8e78e4ea4aad996838c7ab19cb635d72
MD5 4493fc95c72a4bcf43e94ba71bef65d5
BLAKE2b-256 f06c77db537db7ca0a27b92499ba9460d94d91a831ef955f2d8fe509f9cd4e5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aigrok-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for aigrok-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 699d7db9c1d6ac4a77efbaf71bc82aef466bc823d63f50786bf19e3e44cf92a5
MD5 ee6f5e599bec6e0c4a15a802563b16ea
BLAKE2b-256 93cb2c3d81a0c1a646a232279f5342c23355d49ac2670f8ebd98cb4f05d740d8

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