Skip to main content

A Python package for document processing and analysis with LLM integration

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

aigrok-0.2.2-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aigrok-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 11.8 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.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ffe8f1079accb61ad7487b9c9c2cdbe923ef44279695786b8a8e8821ad84987e
MD5 5f6ef60ba1744b85d3a87139881ddd54
BLAKE2b-256 13ac51173598127d043c2098082a1981a5cb2b09d3a63866b44fff956b6aa3a3

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