Skip to main content

Knowledge loader for wish

Project description

wish-knowledge-loader

A CLI tool for loading knowledge bases into wish.

Overview

wish-knowledge-loader is a command-line tool that clones GitHub repositories, extracts content from specified files, and stores them in a vector database for use with wish.

Installation

# Install from the repository
cd wish-knowledge-loader
uv sync --dev

cp .env.example .env
vim .env  # Set the OpenAI API key

Usage

# Basic usage
wish-knowledge-loader --repo-url https://github.com/username/repo --glob "**/*.md" --title "Knowledge Base Title"

Options

  • --repo-url: GitHub repository URL to clone
  • --glob: Glob pattern for files to include (e.g., "**/*.md" for all Markdown files)
  • --title: Title for the knowledge base

Environment Variables

The following environment variables can be set in a .env file:

  • OPENAI_API_KEY: Your OpenAI API key (required)
  • OPENAI_MODEL: OpenAI embedding model to use (default: "text-embedding-3-small")
  • WISH_HOME: Path to the wish home directory (default: "~/.wish")

Development

# Run tests
uv run pytest

# Run linting
uv run ruff check .

Verifying Search Functionality

After creating a knowledge base, you can verify the search functionality using the provided script:

# Set the OpenAI API key
export OPENAI_API_KEY="your-api-key"

# Run the search script
python scripts/search_knowledge.py "Knowledge Base Title" "your search query"

The script will:

  1. Load the vector store for the specified knowledge base
  2. Search for documents similar to your query
  3. Display the top 4 results with their content and metadata

You can adjust the number of results by modifying the k parameter in the script.

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

wish_knowledge_loader-0.1.1.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

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

wish_knowledge_loader-0.1.1-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file wish_knowledge_loader-0.1.1.tar.gz.

File metadata

  • Download URL: wish_knowledge_loader-0.1.1.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for wish_knowledge_loader-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3fe99c24f6f5434438a9a203d1f1efe4975856802bee28f9e96a1595bee1a53d
MD5 69748e2464cf1edc7f26f916e9b6dec2
BLAKE2b-256 ebcf71dcd33c8c82a3d9bc86b1d18dab3df94f4a7d19cdcf130df5cb3e6f765c

See more details on using hashes here.

File details

Details for the file wish_knowledge_loader-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wish_knowledge_loader-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 242ec885074590bb4a397fba536341987dd2e17795a8f54f4300750bfbd4d959
MD5 46d1c436ceabe9f21af61463a309d2b6
BLAKE2b-256 8a7cacad9982b1750dd0eecf191fce388668df27cb2e1213257c039d7d57b415

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