Skip to main content

A command line tool for quick concept lookups

Project description

LiteLookup

LiteLookup is a command-line tool developed in Python that fetches beginner-level information about any concept directly from the command line. This tool is designed for users who want quick, concise, and accessible explanations without leaving their terminal.

Features

  • Command-Line Interface (CLI): Uses argparse to handle user inputs.
  • Error Handling: Validates user input to ensure meaningful queries. Catches special characters and raises appropriate errors.
  • API Integration: Utilizes the Groq LLM API to generate concise explanations of the concepts provided.
  • Caching: Implements Redis for persistent caching of API responses, reducing unnecessary API calls and improving response times.
  • Expandable: Designed to be easily extended with new features and enhancements.

Installation

Prerequisites

  • Python 3.8 or higher
  • Redis server installed and running
  • Groq LLM API access (get your free API key)

Setup

  1. Install LiteLookup via pip:

    pip install litelookup

  2. Configure the environment variables:

    export GROQ_API_KEY=your_api_key_here

  3. Ensure Redis is running:

    redis-cli ping

    You should get PONG which indicates redis is up and running.

Usage

To fetch information about a concept, use the following command:

lookup "concept"

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

litelookup-0.1.4.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

litelookup-0.1.4-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file litelookup-0.1.4.tar.gz.

File metadata

  • Download URL: litelookup-0.1.4.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for litelookup-0.1.4.tar.gz
Algorithm Hash digest
SHA256 10fbe3b2d794d06580ee3de87dab85ec96bbd8b2373a3e63d66551569e3545c3
MD5 e4b79e842dd34889f84fd3c61af82152
BLAKE2b-256 a774a58b2269e1b90df36655c026bf51cb1300201f9d9b0a530b893453a7aedb

See more details on using hashes here.

File details

Details for the file litelookup-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: litelookup-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for litelookup-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 84c831d723922b236aed90f6b5cc10f838d17720a20c077b72c9bd56a1ba8ca4
MD5 15b0973f1d6c2ceda01b4e06be4d4a55
BLAKE2b-256 a01d2bc8b63f6e65f34ef3c4b64eb32ef690f636a02b1dd776fa3f06eb723277

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page