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
  • 🔍 Smart content extraction
  • 💾 Result caching for performance
  • 🛠️ Extensible plugin system
  • 📊 Comprehensive reporting

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+
  • Ollama with vision models installed
  • 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.1.tar.gz (37.0 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.1-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aigrok-0.3.1.tar.gz
  • Upload date:
  • Size: 37.0 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.1.tar.gz
Algorithm Hash digest
SHA256 3e646edb5929520541246233a1e68910cee8f9e466246aab7027281215109d59
MD5 02895ce2cbce3e552d7801e0e90fe913
BLAKE2b-256 ae7336e07604f50baf778582fd971c8f5214a022252a0f3a8711cfa90b94405f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aigrok-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 22.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74a2af1b3d907cf637573ed98f798201a6aa021dc7cfc5918340c71902d6969c
MD5 37527c26d01c00c3cb35074119878a12
BLAKE2b-256 2e28e2eefc1f15408d1e63b9aafe17d1f4ffa26b7a7c6da53db3f85a89f951d9

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