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
-
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+
- 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 Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aigrok-0.2.6.tar.gz.
File metadata
- Download URL: aigrok-0.2.6.tar.gz
- Upload date:
- Size: 29.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f05696ee7aa30d2c203c13e6c0ceeec5a8f71ff8aa703a10440d8653f9242f2d
|
|
| MD5 |
b9e496ca020fdac884da13c255d46223
|
|
| BLAKE2b-256 |
1565ff1145128fa2dc3bd6b22999912126a02c5d5365fabea0cc288045d90438
|
File details
Details for the file aigrok-0.2.6-py3-none-any.whl.
File metadata
- Download URL: aigrok-0.2.6-py3-none-any.whl
- Upload date:
- Size: 20.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e38c1ca6242c8253a847b47dad30986f17d1551685500d616b680d5f8c26e687
|
|
| MD5 |
348daa6e5b3130a1abab1c0ca2e4d171
|
|
| BLAKE2b-256 |
5cf4d71a8d379c886de87c1e0df9d35a86c72f184221164e3f84a2cd18d74beb
|