Skip to main content

A Python package for building RAG systems with HawkinsDB and multiple data source integrations

Project description

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.

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.

hawkins_rag-0.1.0-py3-none-any.whl (64.6 kB view details)

Uploaded Python 3

File details

Details for the file hawkins_rag-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hawkins_rag-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 64.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.10

File hashes

Hashes for hawkins_rag-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54ad186f4823d075aa65d30c3c61a75d28afc50237fa0203d9a3bb4162bbdff8
MD5 59f17e3877b281cf523f6eaa72eba164
BLAKE2b-256 52d845cf4acab26131eff872e8bb5bf9fb5c9c3429e5dd65b0d7545eb056c9f5

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