Back to packageRELEASE DETAILS

0.3.3

PyPI

aigrok

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

Published21 Dec 2024

Direct dependencies13

Transitive dependenciesNot calculated

README

Version 0.3.3 documentation

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

Install AIGrok:
```
pip install aigrok
```
Set up your configuration:
```
aigrok config init
```
Process a document:
```
aigrok process document.pdf
```

Documentation

For detailed documentation, please see the docs directory:

CLI Reference - Command-line interface guide
API Documentation - API reference
Configuration - Configuration guide
Deployment - Deployment instructions
Architecture - System architecture
Contributing - Contribution guidelines

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.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 13

Native requirements

13 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
pypdf Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pypdf>=5.1.0`	runtime
python-dotenv Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`python-dotenv>=1.0.0`	runtime
pytest Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pytest>=7.4.3`	runtime
pytest-cov Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pytest-cov>=4.1.0`	runtime
pydantic Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pydantic>=2.5.2`	runtime
loguru Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`loguru>=0.7.2`	runtime
requests Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`requests>=2.31.0`	runtime
pillow Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pillow>=10.1.0`	runtime
ollama Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`ollama>=0.1.6`	runtime
litellm Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`litellm>=1.30.3`	runtime
pymupdf Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pymupdf>=1.23.8`	runtime
pyyaml Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`pyyaml>=6.0.1`	runtime
easyocr Environment { "extras": "", "marker": null, "requires_python": ">=3.8", "evaluation": "NOT_EVALUATED" }	`easyocr>=1.7.1`	runtime