| Name | versed JSON |
| Version |
0.0.11
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-01-20 04:17:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# versed
[](https://pypi.org/project/versed)
[](https://pypi.org/project/versed)
-----
Versed is a document chat app with Google Drive integration.
## Table of Contents
- [Quick Start](#quick-start)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [License](#license)
## Quick Start
Install using **pipx**:
```console
pipx install versed
```
Run `versed` in your terminal:
```console
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](https://pipx.pypa.io/stable/installation/) 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](https://platform.openai.com) and then [create an API key](https://platform.openai.com/api-keys) once logged in.
### Linux (Debian / Ubuntu)
Install `pipx`:
```console
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:
```console
pipx install versed
```
### Windows
To install **pipx** using pip, run the following command.
```console
# 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:
```console
pipx install versed
```
## Getting Started
## License
`versed` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "versed",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "lachiewalker <lachiewalker1@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/56/0d/c4ca43b94652e20f353736d8374fed7a0fb28c4971fa8b2ee83f1d314d4e/versed-0.0.11.tar.gz",
"platform": null,
"description": "# versed\n\n[](https://pypi.org/project/versed)\n[](https://pypi.org/project/versed)\n\n-----\n\nVersed is a document chat app with Google Drive integration.\n\n## Table of Contents\n\n- [Quick Start](#quick-start)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [License](#license)\n\n## Quick Start\n\nInstall using **pipx**:\n\n```console\npipx install versed\n```\n\nRun `versed` in your terminal:\n\n```console\nversed\n```\n\nFrom the API key selection screen choose `\"Add a New Key\"` and add fill in the required fields to add a valid OpenAI API key.\n\n- **Optional** - Select the `\"Google Drive\"` tab in the left pane and complete the log in flow to enable indexing files from your Google Drive.\n\nChoose a file from the file view pane and index it by clicking `\"Add to Index\"`... and ask away!\n\n## Installation\n\nVersed requires Python3.9 or newer to run.\nVersed is best run using `pipx`, which will manage a virtual environment for all dependencies for you, to avoid collisions with other software.\n\n### Requirements\n\n- **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.\n- **pipx** - Pipx manages virtual enviroments for each installed app, helping to avoid dependency collisions. Follow the instructions below or visit [pipx's installation guide](https://pipx.pypa.io/stable/installation/) for instructions.\n- **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](https://platform.openai.com) and then [create an API key](https://platform.openai.com/api-keys) once logged in.\n\n### Linux (Debian / Ubuntu)\n\nInstall `pipx`:\n\n```console\nsudo apt update\nsudo apt install pipx\n```\n\nAfter 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\n\nNow `versed` can be installed using `pipx` as follows:\n\n```console\npipx install versed\n```\n\n### Windows\n\nTo install **pipx** using pip, run the following command.\n\n```console\n# If you installed python using Microsoft Store, replace `py` with `python3` in the next line.\npy -m pip install --user pipx\n```\n\nNow `versed` can be installed using **pipx** as follows:\n\n```console\npipx install versed\n```\n\n## Getting Started\n\n## License\n\n`versed` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.11",
"project_urls": {
"Documentation": "https://github.com/lachiewalker/versed#readme",
"Issues": "https://github.com/lachiewalker/versed/issues",
"Source": "https://github.com/lachiewalker/versed"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7ecaf165f585c91d9bd9af26ca37ddde9ed78cef0ecce26d0d5e71d13461b8da",
"md5": "7f7289820ec49315ed9155cc2e6b19e1",
"sha256": "ce9f5e64e8f3424d9b8db44fa06a8571b468dbf3be585ef1ee56478555da4861"
},
"downloads": -1,
"filename": "versed-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f7289820ec49315ed9155cc2e6b19e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 28483,
"upload_time": "2025-01-20T04:17:01",
"upload_time_iso_8601": "2025-01-20T04:17:01.727348Z",
"url": "https://files.pythonhosted.org/packages/7e/ca/f165f585c91d9bd9af26ca37ddde9ed78cef0ecce26d0d5e71d13461b8da/versed-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "560dc4ca43b94652e20f353736d8374fed7a0fb28c4971fa8b2ee83f1d314d4e",
"md5": "b5c81abb455f24febd9d9791002f2cef",
"sha256": "dbe2adf4e8898d17f115d70347e478668182d078a58e3dc6f3be13ca4c74b65b"
},
"downloads": -1,
"filename": "versed-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "b5c81abb455f24febd9d9791002f2cef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19168,
"upload_time": "2025-01-20T04:17:04",
"upload_time_iso_8601": "2025-01-20T04:17:04.090877Z",
"url": "https://files.pythonhosted.org/packages/56/0d/c4ca43b94652e20f353736d8374fed7a0fb28c4971fa8b2ee83f1d314d4e/versed-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-20 04:17:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lachiewalker",
"github_project": "versed#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "versed"
}
