Skip to main content

Knowledge loader for wish

Project description

wish-knowledge-loader

A CLI tool for managing knowledge bases in wish.

Overview

wish-knowledge-loader is a command-line tool that allows you to:

  • Load knowledge from GitHub repositories into wish
  • List existing knowledge bases
  • Delete knowledge bases when no longer needed

For detailed usage instructions, see the Knowledge Loader Usage Guide.

Installation

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

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

Quick Reference

# Load a knowledge base
wish-knowledge-loader load --repo-url https://github.com/username/repo --glob "**/*.md" --title "Knowledge Base Title"

# List all knowledge bases
wish-knowledge-loader list

# Delete a knowledge base
wish-knowledge-loader delete --title "Knowledge Base Title"

Environment Variables

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

  • OPENAI_API_KEY: Your OpenAI API key (required)
  • OPENAI_EMBEDDING_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.6.21.tar.gz (36.4 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.6.21-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wish_knowledge_loader-0.6.21.tar.gz
Algorithm Hash digest
SHA256 9f5dad350de0ce396451add039829304450d90d4d9a795c0649653c404f04a39
MD5 7eb198e6750a0129f47653c39e7c0cad
BLAKE2b-256 310041e9101b8b4d5eb2e2866599d8099cb1c4d8b74932706c1b6e593842f222

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wish_knowledge_loader-0.6.21-py3-none-any.whl
Algorithm Hash digest
SHA256 3e991d8e398ec57d05a6192cf58343188f179c8bf8d4b8c7d8012ed5fccf1dac
MD5 9a660324c4296c192c9ed8aaa81a9b65
BLAKE2b-256 c493058db7cb3ce334f6978effe48e97a4ff662e6ef86b34c1e2aa7b486e46b5

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