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.17.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.17-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wish_knowledge_loader-0.6.17.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.17.tar.gz
Algorithm Hash digest
SHA256 e4972da0aade373cd7985348382ee25f554369ae3a32b3a898e22cf1da068892
MD5 d9ea0b4e99104c5b4b03b56362b170c4
BLAKE2b-256 7666bbb1223602b4d8001fce30baf716bddb88982878a3c8f026f5f27fc2e5fc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wish_knowledge_loader-0.6.17-py3-none-any.whl
Algorithm Hash digest
SHA256 deabe7ea8592506080c2c60e9e4128f37b6c3316970e68792dc46abeeba62a88
MD5 7ad8f99bc5ccff3ab382f4f5f3013120
BLAKE2b-256 aa6ef238fcae2d17a77435d0db4c1072d0d4a4379cfd2679bdc498b1754ac2cc

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