A voice assistant for the command line
Project description
Jarvis Conversationalist
Jarvis Conversationalist is a Python-based project that provides a conversational interface using OpenAI's GPT-4 model. It uses text-to-speech and speech-to-text functionalities to facilitate a more interactive and engaging user experience.
Features
- Real-time text-to-speech conversion: The application converts text responses from the GPT-4 model into speech, providing an auditory response to the user.
- Speech-to-text conversion: The application can convert spoken user input into text, which is then processed by the GPT-4 model.
- Multiprocessing and threading: The application uses Python's multiprocessing and threading capabilities to handle multiple tasks concurrently, ensuring smooth and responsive operation.
- Configurable: The application allows users to set their OpenAI API username and key, and also provides an option to reset these settings.
Installation
This project requires Python 3.11 or later. For mac, install portaudio and then pip install the package:
brew install portaudio
pip install jarvis_conversationalist
Usage
To start the application, run the cli.py
script from the command line:
jarvis
You can interrupt the conversation by pressing "Enter". To quit the application, press "Esc" then "Enter".
Configuration
You can set your OpenAI API username and key using the --user
and --key
command-line arguments, respectively:
jarvis --user YOUR_USERNAME --key YOUR_KEY
To reset the saved username and key, use the --reset
command-line argument:
jarvis --reset
Non Technical Installation Instructions
Installing Jarvis Conversationalist on a Mac=
1. Install Python:
Jarvis Conversationalist requires Python 3.11 or later.
Go to the Python official website and download the version 3.11 for Mac.
or just download this...
https://www.python.org/ftp/python/3.11.0/python-3.11.0-macos11.pkg
Open the downloaded file and follow the installation instructions.
2. Install Homebrew (if you don't have it installed already):
In Terminal, type:
brew install portaudio
Then press Enter.
If that doesn't work then you need to install homebrew.
Homebrew is a package manager for Mac that simplifies the installation of software.
Open the Terminal app on your Mac (you can find it in Applications > Utilities).
Copy and paste the following command into Terminal and press Enter:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Follow the on-screen instructions to complete the installation.
3. Install Portaudio
Portaudio is needed for the audio functionalities of Jarvis.
In Terminal, type:
brew install portaudio
Then press Enter.
4. Install Jarvis Conversationalist:
In Terminal, type:
pip3.11 install jarvis_conversational
Then press Enter.
Wait for the installation to complete.
5. Finding Your OpenAI API Key - Create Open an OpenAI Account:
Visit OpenAI's website and sign up or log in. After logging in, navigate to the API section.
https://platform.openai.com/api-keys
6. Generate an API Key:
In the API section, you should see an option to create a new API key.
Follow the instructions to generate a new key.
Once generated, make sure to copy and save your API key in a secure place.
Using Jarvis Conversationalist
7. Start the Application:
To set your OpenAI API username and key, use:
jarvis --u= ser YOUR_USERNAME --key YOUR_KEY
Replace YOUR_USERNAME and YOUR_KEY = with your actual OpenAI username and API key.
After your first successful use go to terminal
jarvis
Then press Enter, to use Jarvis!
8. Updating Jarvis Conversationalist:
To update Jarvis Conversationalist, use:
pip3.11 install --upgrade jarvis_conversationalist
Contributing
Contributions are welcome! Please feel free to submit a pull request.
License
This project is licensed under the terms of the GPL 3 license.
Project details
Release history Release notifications | RSS feed
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 jarvis_conversationalist-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 496face87c4b37120f4eb7e54613cf783c14a64b4133b1237dd6e2de80d80f4f |
|
MD5 | 1699f08ac1056526f45119e281f904c4 |
|
BLAKE2b-256 | e9ab77de429f22e90920034466f8594c62eebcd121ecb66fbd660057be0f27e3 |
Hashes for jarvis_conversationalist-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc65ad375903ec09ac596770167b7fed43938344e8824b7ccf0d03cffdbe5080 |
|
MD5 | 08ad67ff71605a8b83fdd92c886950f0 |
|
BLAKE2b-256 | 639cccbdc84ea685af0c361f77b1f146f1faea8d0992c69463c20ac82b254b6f |