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.3.tar.gz (39.4 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.3-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aigrok-0.3.3.tar.gz
  • Upload date:
  • Size: 39.4 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.3.tar.gz
Algorithm Hash digest
SHA256 40af3015ecc9f2daa0bc1dad0116890866b9760eb088da50981f90f9f64f0f53
MD5 07d2bd1987d768905b9e3766ef65a5b9
BLAKE2b-256 5f0fc7220ca1bacd603e57870a18f19fe31412de31d2ff416ea76cf86dcd2b5b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aigrok-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 22.6 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7f959fa1d8aba2a86c9009a3e2fba75d03291b9050a5c8e2d617504a5e68d2d4
MD5 0cec6413b1ee59d23806821cd540b3c9
BLAKE2b-256 5eee9a3d619c97d4e79d51e1c141cd1ef1573c27516a68507680d3c9c2bf78e3

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