vimlm 0.0.7__py3-none-any.whl → 0.0.9__py3-none-any.whl

vimlm-0.0.9.dist-info/METADATA

@@ -0,0 +1,169 @@
+Metadata-Version: 2.2
+Name: vimlm
+Version: 0.0.9
+Summary: VimLM - LLM-powered Vim assistant
+Home-page: https://github.com/JosefAlbers/vimlm
+Author: Josef Albers
+Author-email: albersj66@gmail.com
+Requires-Python: >=3.12.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nanollama>=0.0.5
+Requires-Dist: mlx_lm_utils>=0.0.3
+Requires-Dist: watchfiles==1.0.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# VimLM - AI-Powered Coding Assistant for Vim
+
+![VimLM Demo](https://raw.githubusercontent.com/JosefAlbers/VimLM/main/assets/captioned_vimlm.gif)
+
+VimLM brings the power of AI directly into your Vim workflow. Maintain focus with keyboard-driven interactions while leveraging AI for code generation, refactoring, and documentation.
+
+Get started quickly with the [tutorial](tutorial.md).
+
+## Features
+- **Native Vim Integration** - Split-window responses & intuitive keybindings
+- **Offline First** - 100% local execution with MLX-compatible models
+- **Contextual Awareness** - Integrates seamlessly with your codebase and external resources
+- **Conversational Workflow** - Iterate on responses with follow-up queries
+- **Project Scaffolding** - Generate and deploy code blocks to directories
+- **Extensible** - Create custom LLM workflows with command chains
+
+## Requirements
+- Apple Silicon (M-series)
+- Python 3.12.8
+- Vim 9.1
+
+## Quick Start
+```bash
+pip install vimlm
+vimlm
+```
+
+## Basic Usage
+
+| Key Binding | Mode          | Action                                 |
+|-------------|---------------|----------------------------------------|
+| `Ctrl-l`    | Normal/Visual | Prompt LLM                             |
+| `Ctrl-j`    | Normal        | Continue conversation                  |
+| `Ctrl-p`    | Normal/Visual | Import generated code                  |
+| `Esc`       | Prompt        | Cancel input                           |
+
+### 1. **Contextual Prompting**
+`Ctrl-l` to prompt LLM with context:
+- Normal mode: Current file + line
+- Visual mode: Current file + selected block
+
+*Example Prompt*: `Create a Chrome extension`
+
+### 2. **Conversational Refinement**
+`Ctrl-j` to continue current thread.
+
+*Example Prompt*: `Use manifest V3 instead`
+
+### 3. **Code Substitution**
+`Ctrl-p` to insert generated code block
+- In Normal mode: Into last visual selection
+- In Visual mode: Into current visual selection 
+
+*Example Workflow*:  
+1. Select a block of code in Visual mode  
+2. Prompt with `Ctrl-l`: `Use regex to remove html tags from item.content`  
+3. Press `Ctrl-p` to replace selection with generated code  
+
+## Inline Directives
+```text
+:VimLM [PROMPT] [!command1] [!command2]...
+```
+
+`!` prefix to embed inline directives in prompts:
+
+| Directive        | Description                              |
+|------------------|------------------------------------------|
+| `!include PATH`  | Add file/directory/shell output to context |
+| `!deploy DEST`   | Save code blocks to directory            |
+| `!continue N`    | Continue stopped response                |
+| `!followup`      | Continue conversation           |
+
+### 1. **Context Layering**
+```text
+!include [PATH]  # Add files/folders to context
+```
+- **`!include`** (no path): Current folder  
+- **`!include ~/projects/utils.py`**: Specific file  
+- **`!include ~/docs/api-specs/`**: Entire folder  
+- **`!include $(...)`**: Shell command output
+
+*Example*: `Summarize recent changes !include $(git log --oneline -n 50)`
+
+### 2. **Code Deployment**
+```text
+!deploy [DEST_DIR]  # Extract code blocks to directory
+```
+- **`!deploy`** (no path): Current directory  
+- **`!deploy ./src`**: Specific directory  
+
+*Example:* `Create REST API endpoint !deploy ./api`
+
+### 3. **Extending Response**
+```text
+!continue [MAX_TOKENS]  # Continue stopped response
+```
+- **`!continue`**: Default 2000 tokens  
+- **`!continue 3000`**: Custom token limit  
+
+*Example:* `tl;dr !include large-file.txt !continue 5000`
+
+## Command-Line Mode
+```vim
+:VimLM prompt [!command1] [!command2]...
+```
+
+Simplify complex tasks by chaining multiple commands together into a single, reusable Vim command.
+
+*Examples*:
+```vim
+" Debug CI failures using error logs
+:VimLM Fix Dockerfile !include .gitlab-ci.yml !include $(tail -n 20 ci.log)
+
+" Generate unit tests for selected functions and save to test/
+:VimLM Write pytest tests for this !include ./src !deploy ./test
+
+" Add docstrings to all Python functions in file
+:VimLM Add Google-style docstrings !include % !continue 4000
+```
+
+## Configuration
+
+### 1. **Model Settings**
+Edit `~/vimlm/cfg.json`:
+```json
+{
+  "LLM_MODEL": "mlx-community/DeepSeek-R1-Distill-Qwen-7B-4bit",
+  "NUM_TOKEN": 32768
+}
+```
+
+### 2. **Key Customization**
+```json
+{
+  "USE_LEADER": true,
+  "KEY_MAP": {
+    "l": "]",
+    "j": "[",
+    "p": "p" 
+  }
+}
+```
+
+## License
+
+Apache 2.0 - See [LICENSE](LICENSE) for details.

vimlm-0.0.9.dist-info/RECORD

@@ -0,0 +1,7 @@
+vimlm.py,sha256=n0rCiqHJQ1ouKZD-0C9rcE6rAC4d1bVriKTx5303Dmo,25180
+vimlm-0.0.9.dist-info/LICENSE,sha256=f1xgK8fAXg_intwnbc9nLkHf7ODPLtgpHs7DetQHOro,11343
+vimlm-0.0.9.dist-info/METADATA,sha256=xhXHiDlYY44vN12JgbsZHcgRJDy01-hDOCcm05ZQHng,4942
+vimlm-0.0.9.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+vimlm-0.0.9.dist-info/entry_points.txt,sha256=mU5V4MYsuIzCc6YB-Ro-6USSHWN5vHw8UDnTEoq0isw,36
+vimlm-0.0.9.dist-info/top_level.txt,sha256=I8GjqoiP--scYsO3AfLhha-6Ax9ci3IvbWvVbPv8g94,6
+vimlm-0.0.9.dist-info/RECORD,,

vimlm.py

@@ -18,7 +18,7 @@ import json
 import os
 from watchfiles import awatch
 import shutil
-import time
+from datetime import datetime
 from itertools import accumulate
 import argparse
 import tempfile
@@ -34,10 +34,11 @@ DEFAULTS = dict(
     DO_RESET = True,
     SHOW_USER = False, 
     SEP_CMD = '!',
-    VERSION = '0.0.7',
-    DEBUG = True,
+    VERSION = '0.0.9',
+    DEBUG = False,
 )
 
+DATE_FORM = "%Y_%m_%d_%H_%M_%S"
 VIMLM_DIR = os.path.expanduser("~/vimlm")
 WATCH_DIR = os.path.expanduser("~/vimlm/watch_dir")
 CFG_FILE = 'cfg.json'
@@ -70,7 +71,7 @@ try:
         for p in [CFG_PATH, LOG_PATH, LTM_PATH]:
             if os.path.isfile(p):
                 os.remove(p)
-        raise ValueError(f'Version mismatch')
+        raise ValueError(f'Updating config')
 except Exception as e:
     print(e)
     config = DEFAULTS
@@ -95,10 +96,22 @@ def tolog(log, key='debug'):
             logs = json.load(log_f)
     except:
         logs = []
-    logs.append(dict(key=key, log=log, timestamp=time.ctime()))
+    logs.append(dict(key=key, log=log, timestamp=datetime.now().strftime(DATE_FORM)))
     with open(LOG_PATH, "w", encoding="utf-8") as log_f:
         json.dump(logs, log_f, indent=2)
 
+def print_log():
+    with open(LOG_PATH, 'r') as f:
+        logs = json.load(f)
+    for log in logs:
+        print(f'\033[37m{log["key"]} {log["timestamp"]}\033[0m')
+        if 'tovim' in log["key"]:
+            print('\033[33m')
+        elif 'tollm' in log["key"]:
+            print('\033[31m')
+        print(log["log"])
+        print('\033[0m')
+
 toout('Loading LLM...')
 if LLM_MODEL is None:
     from nanollama import Chat
@@ -117,6 +130,7 @@ def deploy(dest=None, src=None, reformat=True):
         with open(src, 'r') as f:
             prompt_deploy = f.read().strip() + '\n\n---\n\n' + prompt_deploy
     if reformat:
+        toout('Deploying...')
         response = chat(prompt_deploy, max_new=NUM_TOKEN, verbose=False, stream=False)['text']
         toout(response, 'deploy')
         lines = response.splitlines()
@@ -371,6 +385,14 @@ def process_command(data):
                 return data
             data['user_prompt'] += "\n\nEnsure that each code block is preceded by a filename in **filename.ext** format. The filename should only contain alphanumeric characters, dots, underscores, or hyphens. Ensure that any extraneous characters are removed from the filenames."
             data['deploy_dest'] = arg
+    for cmd in cmds:
+        if cmd.startswith('write'):
+            arg = cmd.removeprefix('write').strip().strip('(').strip(')').strip().strip('"').strip("'").strip()
+            if len(arg) == 0:
+                arg = 'response'
+                pass
+            timestamp = datetime.now().strftime(DATE_FORM)
+            data['write_dest'] = re.sub(r"[^a-zA-Z0-9_.-]", "", f'{arg}_{timestamp}.md')
     return data
     
 async def monitor_directory():
@@ -423,7 +445,10 @@ async def process_files(data):
         toout(response['text'])
     else:
         toout(response['text'])
-    tolog(response['benchmark'])
+    tolog(response)
+    if 'write_dest' in data:
+        with open(data['write_dest'], 'w') as f:
+            f.write(response['text'])
     if 'deploy_dest' in data:
         deploy(dest=data['deploy_dest'], reformat=False)
 
@@ -434,6 +459,43 @@ mapl, mapj, mapp = (f'<Leader>{KEYL}', f'<Leader>{KEYJ}', f'<Leader>{KEYP}') if
 VIMLMSCRIPT = Template(r"""
 let s:register_names = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u'] 
 let s:watched_dir = expand('$WATCH_DIR')
+let s:vimlm_enabled = 1
+
+function! ToggleVimLM()
+    if s:vimlm_enabled
+        let s:vimlm_enabled = 0
+        let response_path = s:watched_dir . '/response.md'
+        let bufnum = bufnr(response_path)
+        let winid = bufwinnr(bufnum)
+        if winid != -1
+            execute winid . 'wincmd c'
+        endif
+        if exists('s:monitor_timer')
+            call timer_stop(s:monitor_timer)
+            unlet s:monitor_timer
+        endif
+        echohl WarningMsg | echom "VimLM disabled" | echohl None
+    else
+        let s:vimlm_enabled = 1
+        silent! call Monitor()
+        echohl WarningMsg | echom "VimLM enabled" | echohl None  
+    endif
+endfunction
+
+function! CheckForUpdates(timer)
+    if !s:vimlm_enabled
+        return
+    endif
+    let bufnum = bufnr(s:watched_dir . '/response.md')
+    let winid = bufwinnr(bufnum)
+    if winid == -1
+        call timer_stop(s:monitor_timer)
+        unlet s:monitor_timer
+        call Monitor()
+    else
+        silent! checktime
+    endif
+endfunction
 
 function! Monitor()
     if exists('s:monitor_timer')
@@ -456,13 +518,16 @@ function! Monitor()
     let s:monitor_timer = timer_start(100, 'CheckForUpdates', {'repeat': -1})
 endfunction
 
-function! CheckForUpdates(timer)
+function! ScrollToTop()
     let bufnum = bufnr(s:watched_dir . '/response.md')
-    if bufnum == -1
-        call timer_stop(s:monitor_timer)
-        return
+    if bufnum != -1
+        let winid = bufwinnr(bufnum)
+        if winid > 0
+            execute winid . "wincmd w"
+            normal! gg
+            wincmd p
+        endif
     endif
-    silent! checktime
 endfunction
 
 function! s:CustomInput(prompt) abort
@@ -486,14 +551,13 @@ function! SaveUserInput(prompt)
     let current_file = expand('%:p')
     let tree_file = s:watched_dir . '/tree'
     call writefile([current_file], tree_file, 'w')
+    call ScrollToTop()
 endfunction
 
 function! VisualPrompt()
     silent! execute "normal! \<ESC>"
     silent execute "'<,'>w! " . s:watched_dir . "/yank"
     silent execute "w! " . s:watched_dir . "/context"
-    " silent! execute "normal! `<V`>"
-    " silent! execute "normal! \<ESC>"
     call SaveUserInput('VimLM: ')
 endfunction
 
@@ -501,7 +565,6 @@ function! NormalPrompt()
     silent! execute "normal! V\<ESC>"
     silent execute "'<,'>w! " . s:watched_dir . "/yank"
     silent execute "w! " . s:watched_dir . "/context"
-    " silent! execute "normal! \<ESC>"
     call SaveUserInput('VimLM: ')
 endfunction
 
@@ -557,18 +620,15 @@ function! PasteIntoLastVisualSelection(...)
         echo "Extracted " . num_blocks . " blocks into registers @a-@" . s:register_names[num_blocks - 1] . ". Enter register name: "
         let register_name = nr2char(getchar())
     endif
-
     if register_name !~ '^[a-z]$'
         echoerr "Invalid register name. Please enter a single lowercase letter (e.g., a, b, c)."
         return
     endif
-
     let register_content = getreg(register_name)
     if register_content == ''
         echoerr "Register @" . register_name . " is empty."
         return
     endif
-
     let current_mode = mode()
     if current_mode == 'v' || current_mode == 'V' || current_mode == ''
         execute 'normal! "' . register_name . 'p'
@@ -579,6 +639,10 @@ function! PasteIntoLastVisualSelection(...)
 endfunction
 
 function! VimLM(...) range
+    let tree_file = s:watched_dir . '/tree'
+    while filereadable(tree_file)
+        sleep 100m
+    endwhile
     let user_input = join(a:000, ' ')
     if empty(user_input)
         echo "Usage: :VimLM <prompt> [!command1] [!command2] ..."
@@ -592,10 +656,11 @@ function! VimLM(...) range
     let user_file = s:watched_dir . '/user'
     call writefile([user_input], user_file, 'w')
     let current_file = expand('%:p')
-    let tree_file = s:watched_dir . '/tree'
     call writefile([current_file], tree_file, 'w')
+    call ScrollToTop()
 endfunction
 
+command! ToggleVimLM call ToggleVimLM()
 command! -range -nargs=+ VimLM call VimLM(<f-args>)
 nnoremap $mapp :call PasteIntoLastVisualSelection()<CR>
 vnoremap $mapp <Cmd>:call PasteIntoLastVisualSelection()<CR>
@@ -611,7 +676,6 @@ async def main():
     parser.add_argument("vim_args", nargs=argparse.REMAINDER, help="Vim arguments")
     args = parser.parse_args()
     if args.test:
-        test()
         return
     with tempfile.NamedTemporaryFile(mode='w', suffix='.vim', delete=False) as f:
         f.write(VIMLMSCRIPT)

vimlm-0.0.7.dist-info/METADATA

@@ -1,204 +0,0 @@
-Metadata-Version: 2.2
-Name: vimlm
-Version: 0.0.7
-Summary: VimLM - LLM-powered Vim assistant
-Home-page: https://github.com/JosefAlbers/vimlm
-Author: Josef Albers
-Author-email: albersj66@gmail.com
-Requires-Python: >=3.12.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: nanollama==0.0.5
-Requires-Dist: mlx_lm_utils==0.0.2
-Requires-Dist: watchfiles==1.0.4
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-
-# VimLM - Local LLM-Powered Coding Assistant for Vim
-
-![vimlm](https://raw.githubusercontent.com/JosefAlbers/VimLM/main/assets/captioned_vimlm.gif)
-
-LLM-powered coding companion for Vim, inspired by GitHub Copilot/Cursor. Integrates contextual code understanding, summarization, and AI assistance directly into your Vim workflow.
-
-## Features
-
-- **Model Agnostic** - Use any MLX-compatible model via a configuration file
-- **Vim-Native UX** - Intuitive keybindings and split-window responses
-- **Deep Context** - Understands code context from:
-    - Current file
-    - Visual selections
-    - Referenced files
-    - Project directory structure
-- **Conversational Coding** - Iterative refinement with follow-up queries
-- **Air-Gapped Security** - 100% offline - no APIs, no tracking, no data leaks
-
-## Requirements
-
-- Apple M-series chip
-- Python 3.12.8
-
-## Quick Start
-
-```zsh
-pip install vimlm
-vimlm
-```
-
-## Basic Usage
-
-### 1. **From Normal Mode**  
-**`Ctrl-l`**: Add current line + file to context
-
-*Example prompt:* `"Regex for removing HTML tags from item.content"`
-
-### 2. **From Visual Mode**  
-Select code → **`Ctrl-l`**: Add selected block + current file to context
-
-*Example prompt:* `"Convert this to async/await syntax"`
-
-### 3. **Follow-Up Conversations**  
-**`Ctrl-j`**: Continue current thread
-
-*Example follow-up:* `"Use Manifest V3 instead"`
-
-### 4. **Code Extraction & Replacement**  
-**`Ctrl-p`**: Insert code blocks from response into:  
-- Last visual selection (Normal mode)  
-- Active selection (Visual mode)  
-
-**Workflow Example**:  
-1. Select a block of code in Visual mode  
-2. Prompt with `Ctrl-l`: `"Convert this to async/await syntax"`  
-3. Press `Ctrl-p` to replace selection with generated code  
-
-### 5. **Inline Commands**  
-
-#### `!include` - Add External Context  
-```text
-!include [PATH]  # Add files/folders to context
-```
-- **`!include`** (no path): Current folder  
-- **`!include ~/projects/utils.py`**: Specific file  
-- **`!include ~/docs/api-specs/`**: Entire folder  
-
-*Example:* `"AJAX-ify this app !include ~/scrap/hypermedia-applications.summ.md"`
-
-#### `!deploy` - Generate Project Files  
-```text
-!deploy [DEST_DIR]  # Extract code blocks to directory
-```
-- **`!deploy`** (no path): Current directory  
-- **`!deploy ./src`**: Specific directory  
-
-*Example:* `"Create REST API endpoint !deploy ./api"`
-
-#### `!continue` - Resume Generation  
-```text
-!continue [MAX_TOKENS]  # Continue stopped response
-```
-- **`!continue`**: Default 2000 tokens  
-- **`!continue 3000`**: Custom token limit  
-
-*Example:* `"tl;dr !include large-file.txt !continue 5000"`
-
-#### `!followup` - Thread Continuation  
-```text
-!followup  # Equivalent to Ctrl-j
-```
-*Example:*  
-
-Initial: `"Create Chrome extension"`  
-
-Follow-up: `"Add dark mode support !followup"`
-
-#### **Command Combinations**
-Chain multiple commands in one prompt:  
-```text
-"Create HTMX component !include ~/lib/styles.css !deploy ./components !continue 4000"
-```  
-
-### 6. **Command-Line Mode `:VimLM`**
-```vim
-:VimLM "prompt" [!command1] [!command2]...
-```
-Use predefined command chains for repetitive tasks:
-
-**Example 1 – CI/CD Fixer Macro**:
-```vim
-" Debug CI failures using error logs
-:VimLM Fix Dockerfile !include .gitlab-ci.yml !include $(tail -n 20 ci.log)
-```
-
-**Example 2 – Test Generation Workflow**:
-```vim
-" Generate unit tests for selected functions and save to test/
-:VimLM Write pytest tests for this !include ./src !deploy ./test
-```
-
-**Example 3 – Documentation Helper**:
-```vim
-" Add docstrings to all Python functions in file
-:VimLM Add Google-style docstrings !include % !continue 4000
-```
-
-### Key Bindings
-
-| Binding    | Mode          | Action                                 |
-|------------|---------------|----------------------------------------|
-| `Ctrl-l`   | Normal/Visual | Send current file + selection to LLM   |
-| `Ctrl-j`   | Normal        | Continue conversation                  |
-| `Ctrl-p`   | Normal/Visual | Replace the selection with generated code |
-| `Esc`      | Prompt        | Cancel input                           |
-
-## Advanced Configuration
-VimLM uses a JSON config file with the following configurable parameters:
-```json
-{
-  "LLM_MODEL": null,
-  "NUM_TOKEN": 2000,
-  "USE_LEADER": false,
-  "KEY_MAP": {},
-  "DO_RESET": true,
-  "SHOW_USER": false,
-  "SEP_CMD": "!",
-  "VERSION": "0.0.7",
-  "DEBUG": true
-} 
-```
-### Custom Model Setup
-1. **Browse models**: [MLX Community Models on Hugging Face](https://huggingface.co/mlx-community)
-2. **Edit config file**:
-```json
-{
-  "LLM_MODEL": "mlx-community/DeepSeek-R1-Distill-Qwen-7B-4bit",
-  "NUM_TOKEN": 9999
-}
-```
-3. **Save to**: `~/vimlm/cfg.json`
-4. **Restart VimLM**
-
-### Custom Key Bindings
-You can also configure shortcuts:
-```json
-{
-  "USE_LEADER": true,   // Swap Ctrl for Leader key
-  "KEY_MAP": {          // Remap default keys (l/j/p)
-    "l": "a",           // <Leader>a instead of <Leader>l
-    "j": "s",           // <Leader>s instead of <Leader>j
-    "p": "d"            // <Leader>d instead of <Leader>p
-  }
-}
-```
-
-## License
-
-VimLM is licensed under the [Apache-2.0 license](LICENSE).
-
-

vimlm-0.0.7.dist-info/RECORD

@@ -1,7 +0,0 @@
-vimlm.py,sha256=QrboU-loWuQjTPO5HTJnt_CCxZcV6cclX6UOz438rEM,23126
-vimlm-0.0.7.dist-info/LICENSE,sha256=f1xgK8fAXg_intwnbc9nLkHf7ODPLtgpHs7DetQHOro,11343
-vimlm-0.0.7.dist-info/METADATA,sha256=0V2b8X4pq2uGlyuxyqCUlCYZ7tmlJhPOLZFaDjG0V6s,5668
-vimlm-0.0.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-vimlm-0.0.7.dist-info/entry_points.txt,sha256=mU5V4MYsuIzCc6YB-Ro-6USSHWN5vHw8UDnTEoq0isw,36
-vimlm-0.0.7.dist-info/top_level.txt,sha256=I8GjqoiP--scYsO3AfLhha-6Ax9ci3IvbWvVbPv8g94,6
-vimlm-0.0.7.dist-info/RECORD,,