versed 0.0.9

No project description provided

versed

---

Versed is a document chat app with Google Drive integration.

Table of Contents

• Quick Start
• Installation
• Getting Started
• License

Quick Start

Install using pipx:

pipx install versed

Run versed in your terminal:

versed

From the API key selection screen choose "Add a New Key" and add fill in the required fields to add a valid OpenAI API key.

• Optional - Select the "Google Drive" tab in the left pane and complete the log in flow to enable indexing files from your Google Drive.

Choose a file from the file view pane and index it by clicking "Add to Index"... and ask away!

Installation

Versed requires Python3.9 or newer to run. Versed is best run using pipx, which will manage a virtual environment for all dependencies for you, to avoid collisions with other software.

Requirements

• Python - A version of python3 should come pre-installed on Linux and Mac. If you are on Windows and only need Python for Versed, installing from the Microsoft Store is the easiest way to go.
• pipx - Pipx manages virtual enviroments for each installed app, helping to avoid dependency collisions. Follow the instructions below or visit pipx's installation guide for instructions.
• OpenAI API key - A desktop account for ChatGPT is not the same as an API key. To create an API key for OpenAI you will need to create an account and then create an API key once logged in.

Linux (Debian / Ubuntu)

Install pipx:

sudo apt update
sudo apt install pipx

After installation pipx will prompt you to run pipx ensurepath. Doing so will add pipx to your system's path, enabling pipx to be run from anywhere

Now versed can be installed using pipx as follows:

pipx install versed

Windows

To install pipx using pip, run the following command.

# If you installed python using Microsoft Store, replace `py` with `python3` in the next line.
py -m pip install --user pipx

Now versed can be installed using pipx as follows:

pipx install versed

Getting Started

License

versed is distributed under the terms of the MIT license.