Add your description here
Project description
whisper
Install
To install Whisper, you can use pip:
pip install whisper
Setup
After installing Whisper, you need to initialize the configuration for Whisper. This involves setting up API keys for the services you intend to use, such as OpenAI or Anthropic.
To initialize the configuration, run:
$ whisper init
This will create a basic configuration file in your home directory (~/.whisper/whisper.toml
). You should update this file with your API keys.
Setup with keys
If you have keys for OpenAI or Anthropic handy, you can initialize the configuration with:
$ whisper init --openai-key <your-openai-key> --anthropic-key <your-anthropic-key>
Usage:
$ whisper [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Commands:
ask
: The default command that takes a prompt...config
init
: Initializes the configuration for Whisper,...themes
: Prints a list of available syntax...
whisper ask
The default command that takes a prompt and optional parameters to ask a question using Whisper.
Usage:
$ whisper ask [OPTIONS] PROMPT
Arguments:
PROMPT
: The question you want to ask Whisper [required]
Options:
-k, --key TEXT
: The API To use (openai, anthropic, etc)-m, --model TEXT
: The model that Whisper should use-t, --theme TEXT
: The theme that should be used for the output [default: solarized-dark]--help
: Show this message and exit.
whisper config
Usage:
$ whisper config [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
get
: Get the current configuration for Whisper.set
: Initialize the configuration for Whisper.show
: Show the current configuration for Whisper.
whisper config get
Get the current configuration for Whisper.
Usage:
$ whisper config get [OPTIONS] KEY
Arguments:
KEY
: The key to get the value for. Supports dot notation. e.g. 'openai.api_key' [required]
Options:
--help
: Show this message and exit.
whisper config set
Initialize the configuration for Whisper.
Usage:
$ whisper config set [OPTIONS] KEY VALUE
Arguments:
KEY
: The key to set the value for. Supports dot notation. e.g. 'openai.api_key' [required]VALUE
: The value to set the key to. [required]
Options:
--help
: Show this message and exit.
whisper config show
Show the current configuration for Whisper.
Usage:
$ whisper config show [OPTIONS]
Options:
--help
: Show this message and exit.
whisper init
Initializes the configuration for Whisper, saving API keys to a local file.
Usage:
$ whisper init [OPTIONS]
Options:
--openai-key TEXT
: The OpenAI API key to use--anthropic-key TEXT
: The Anthropic API key to use--show / --no-show
: Show the configuration [default: show]--help
: Show this message and exit.
whisper themes
Prints a list of available syntax highlighting themes from Pygments.
Usage:
$ whisper themes [OPTIONS]
Options:
--help
: Show this message and exit.
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
Built Distribution
Hashes for just_whisper-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 272b85164a7951bf27e3f1629c578e5c6abd5da80fe2a10ac619c48fdeb87057 |
|
MD5 | ec16f373967ca8b888477bc7da13cb66 |
|
BLAKE2b-256 | f258ab22b93c9b7f019d67aa3cf9bb5a96f4469046a6bf105eeda3e7920943fd |