HawkinsRAG
A Python package for building Retrieval-Augmented Generation (RAG) systems with HawkinsDB and multiple data source integrations.
Features
- Multiple data source support through specialized loaders
- Efficient text chunking and embedding
- Seamless integration with HawkinsDB
- Flexible configuration options
- Comprehensive error handling
Installation
pip install hawkins-rag
Quick Start
from hawkins_rag import HawkinsRAG
# Initialize RAG system
rag = HawkinsRAG()
# Load document
result = rag.load_document("document.txt", source_type="text")
# Query content
response = rag.query("What is this document about?")
print(response)
Supported Data Sources
HawkinsRAG supports multiple data sources through specialized loaders:
- Text files (txt, pdf, docx)
- Web content (YouTube, webpages)
- Structured data (JSON, CSV)
- APIs (GitHub, Gmail, Slack)
- Databases (MySQL, PostgreSQL)
- And many more!
Configuration
config = {
"storage_type": "sqlite", # or "postgres"
"db_path": "hawkins_rag.db",
"chunk_size": 500,
"loader_config": {
"youtube": {
"api_key": "YOUR_YOUTUBE_API_KEY"
},
"github": {
"token": "YOUR_GITHUB_TOKEN"
}
}
}
rag = HawkinsRAG(config=config)
License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
For detailed documentation, visit HawkinsRAG Documentation.
Metadata
Release files for hawkins-rag 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hawkins_rag-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for hawkins_rag-0.1.0-py3-none-any.whl |
Release files / hawkins_rag-0.1.0-py3-none-any.whl
| Download URL | hawkins_rag-0.1.0-py3-none-any.whl |
|---|---|
| Size | 64.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
54ad186f4823d075aa65d30c3c61a75d28afc50237fa0203d9a3bb4162bbdff8
|
|
BLAKE2b-256 checksum How to use checksums |
52d845cf4acab26131eff872e8bb5bf9fb5c9c3429e5dd65b0d7545eb056c9f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.10
|
Security for hawkins-rag 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.