v0.6.0 release

.github/workflows/ci.yaml

@@ -25,6 +25,8 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: ["3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
+    env:
+      OPENAI_API_KEY: dummy_value_for_tests # Dummy value
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

.gitignore

@@ -8,8 +8,11 @@ wheels/
 
 # Development files
 .coverage
+.coverage.*
 .env
 *.pdf
 
 # Virtual environments
 .venv
+
+.DS_Store

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
+## [0.6.0]
+### Added
+- Added CLI commands for `assistants list` and `assistants clean`
+- Automatic cleanup of any extra assistants in user account when initiating chat
+- Added docstrings for undocumented functions
+- Test case coverage for most OpenAI chat and vector store operations [#15](https://github.com/jbencina/vecsync/issues/15)
+
+### Changed
+- Updated CLI chat command to `vs chat`
+- Refactored CLI into separate modules
+- Removed assistant ID persistance from settings file and only attempt to retrieve assistant from API
+
 ## [0.5.1]
 ### Fixed
 - Fixed bug where an incorrect thread ID was referenced causing chats to fail

README.md

@@ -70,7 +70,7 @@ Duration: 8.93 seconds
 
  Sync from a Zotero collection. Interactive selections are remembered for future sessions.
 ```bash
-vs sync -s zotero
+vs sync -source zotero
 
 Enter the path to your Zotero directory (Default: /Users/jbencina/Zotero): 
 
@@ -96,11 +96,11 @@ vs settings clear
 ```
 
 #### Chat Interactions
-Use `vs assistant chat` to chat with uploaded documents via the command line. The responding assistant is automatically linked to your
-vector store. Alternatively, you can use `vs assistant ui` to spawn a local Gradio instance.
+Use `vs chat` to chat with uploaded documents via the command line. The responding assistant is automatically linked to your
+vector store. Alternatively, you can use `vs chat -u` to spawn a local Gradio instance.
 
 ```bash
-vs assistant chat
+vs chat
 ✅ Assistant found: asst_123456789
 Type "exit" to quit at any time.
 
@@ -112,7 +112,7 @@ The contents of the vector store collection primarily focus on machine learning
 
 Conversations are remembered across sessions.
 ```bash
-vs assistant chat   
+vs chat   
 ✅ Assistant found: asst_123456789
 ✅ Thread found: thread_123456789
 Type "exit" to quit at any time.
@@ -123,7 +123,7 @@ Your last question to me was asking for a one sentence summary of the contents o
 
 Threads can be cleared using the `-n` flag.
 ```bash
-vs assistant chat -n
+vs chat -n
 ✅ Assistant found: asst_123456789
 Type "exit" to quit at any time.
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vecsync"
-version = "0.5.1"
+version = "0.6.0"
 description = "A simple command-line utility for synchronizing documents to vector storage for LLM interaction."
 readme = "README.md"
 authors = [
@@ -58,7 +58,7 @@ dependencies = [
 ]
 
 [project.scripts]
-vs = "vecsync.cli:cli"
+vs = "vecsync.cli.entry:cli"
 
 [project.urls]
 Homepage = "https://vecsync.io"

src/vecsync/chat/clients/base.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class Assistant(BaseModel):
+    id: str
+    name: str