vexor 0.4.2__tar.gz

vexor-0.4.2/.gitignore

@@ -0,0 +1,159 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+PIPE_MANIFEST
+
+# PyInstaller
+*.manifest
+#*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDE specific files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# SentenceTransformers cache
+.cache/
+sentence_transformers/
+
+# Model cache (HuggingFace)
+.transformers_cache/
+models/
+
+# Project specific
+*.db
+*.sqlite
+test_data/
+temp/
+tmp/

vexor-0.4.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ScarletKc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vexor-0.4.2/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: vexor
+Version: 0.4.2
+Summary: A vector-powered CLI for semantic search over files.
+Project-URL: Repository, https://github.com/scarletkc/vexor
+Author: scarletkc
+License: MIT
+License-File: LICENSE
+Keywords: ai,cli,semantic-search,typer
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: System :: Filesystems
+Classifier: Topic :: Text Processing :: Indexing
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Requires-Dist: charset-normalizer>=3.3.0
+Requires-Dist: google-genai>=0.5.0
+Requires-Dist: numpy>=1.23.0
+Requires-Dist: pypdf>=4.0.0
+Requires-Dist: python-docx>=0.8.11
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: scikit-learn>=1.3.0
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.1; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: twine>=5.1.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/scarletkc/vexor/refs/heads/main/assets/vexor.svg" alt="Vexor" width="50%" height="auto">
+
+# Vexor
+
+[![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/vexor.svg)](https://pypi.org/project/vexor/)
+[![CI](https://img.shields.io/github/actions/workflow/status/scarletkc/vexor/publish.yml?branch=main)](https://github.com/scarletkc/vexor/actions/workflows/publish.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/scarletkc/vexor/main)](https://codecov.io/github/scarletkc/vexor)
+[![License](https://img.shields.io/github/license/scarletkc/vexor.svg)](https://github.com/scarletkc/vexor/blob/main/LICENSE)
+
+</div>
+
+---
+
+Vexor is a vector-powered CLI that searches files semantically. It uses Google GenAI's `gemini-embedding-001` model to embed files and queries, then shows matches with cosine similarity.
+
+## Install
+Download from [releases](https://github.com/scarletkc/vexor/releases) without python, or with:
+```bash
+pip install vexor # or use pipx, uv
+```
+The CLI entry point is `vexor`.
+
+## Configure
+Set the Gemini API key once and reuse it everywhere:
+```bash
+vexor config --set-api-key "YOUR_KEY"
+```
+Optional defaults:
+```bash
+vexor config --set-model gemini-embedding-001
+vexor config --set-batch-size 0   # 0 = single request
+```
+Configuration is stored in `~/.vexor/config.json`.
+
+Inspect or reset every cached index:
+```bash
+vexor config --show-index-all
+vexor config --clear-index-all
+```
+
+## Workflow
+1. **Index** the project root (includes every subdirectory):
+   ```bash
+   vexor index --path ~/projects/demo --mode name --include-hidden
+   ```
+2. **Search** from anywhere, pointing to the same path:
+   ```bash
+   vexor search "api client config" --path ~/projects/demo --mode name --top 5
+   ```
+   Output example:
+   ```
+   Vexor semantic file search results
+   ──────────────────────────────────
+   #   Similarity   File path                      Preview
+   1   0.923        ./src/config_loader.py        config loader entrypoint
+   2   0.871        ./src/utils/config_parse.py   parse config helpers
+   3   0.809        ./tests/test_config_loader.py tests for config loader
+   ```
+
+Tips:
+- Keep one index per project root; subdirectories need separate indexes only if you explicitly run `vexor index` on them.
+- Toggle `--no-recursive` (or `-n`) on both `index` and `search` when you only care about the current directory; recursive and non-recursive caches are stored separately.
+- Hidden files are included only if both `index` and `search` use `--include-hidden`.
+- Re-running `vexor index` only re-embeds files whose names changed (or were added/removed); if more than half the files differ, it automatically falls back to a full rebuild for consistency.
+- Specify the indexing mode with `--mode`; currently `name` (file names only) and `head` (first chunk of supported text/code/PDF/DOCX/etc. files) are available, each with its own cache.
+
+## Commands
+| Command | Description |
+| ------- | ----------- |
+| `vexor index --path PATH --mode MODE [--include-hidden] [--no-recursive] [--clear/--show]` | Scans `PATH` (recursively by default), embeds content according to `MODE` (`name` or `head`), and writes a cache under `~/.vexor`. |
+| `vexor search QUERY --path PATH --mode MODE [--top K] [--include-hidden] [--no-recursive]` | Loads the cached embeddings for `PATH` (matching the chosen mode/recursion/hidden settings), shows matches for `QUERY`. |
+| `vexor doctor` | Checks whether the `vexor` command is available on the current `PATH`. |
+| `vexor update` | Fetches the latest release version and shows links to update via GitHub or PyPI. |
+| `vexor config --set-api-key/--clear-api-key` | Manage the stored Gemini API key. |
+| `vexor config --set-model/--set-batch-size/--show` | Manage default model and batch size. |
+| `vexor config --show-index-all/--clear-index-all` | Inspect or delete every cached index regardless of path/mode. |

vexor-0.4.2/README.md

@@ -0,0 +1,79 @@
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/scarletkc/vexor/refs/heads/main/assets/vexor.svg" alt="Vexor" width="50%" height="auto">
+
+# Vexor
+
+[![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/vexor.svg)](https://pypi.org/project/vexor/)
+[![CI](https://img.shields.io/github/actions/workflow/status/scarletkc/vexor/publish.yml?branch=main)](https://github.com/scarletkc/vexor/actions/workflows/publish.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/scarletkc/vexor/main)](https://codecov.io/github/scarletkc/vexor)
+[![License](https://img.shields.io/github/license/scarletkc/vexor.svg)](https://github.com/scarletkc/vexor/blob/main/LICENSE)
+
+</div>
+
+---
+
+Vexor is a vector-powered CLI that searches files semantically. It uses Google GenAI's `gemini-embedding-001` model to embed files and queries, then shows matches with cosine similarity.
+
+## Install
+Download from [releases](https://github.com/scarletkc/vexor/releases) without python, or with:
+```bash
+pip install vexor # or use pipx, uv
+```
+The CLI entry point is `vexor`.
+
+## Configure
+Set the Gemini API key once and reuse it everywhere:
+```bash
+vexor config --set-api-key "YOUR_KEY"
+```
+Optional defaults:
+```bash
+vexor config --set-model gemini-embedding-001
+vexor config --set-batch-size 0   # 0 = single request
+```
+Configuration is stored in `~/.vexor/config.json`.
+
+Inspect or reset every cached index:
+```bash
+vexor config --show-index-all
+vexor config --clear-index-all
+```
+
+## Workflow
+1. **Index** the project root (includes every subdirectory):
+   ```bash
+   vexor index --path ~/projects/demo --mode name --include-hidden
+   ```
+2. **Search** from anywhere, pointing to the same path:
+   ```bash
+   vexor search "api client config" --path ~/projects/demo --mode name --top 5
+   ```
+   Output example:
+   ```
+   Vexor semantic file search results
+   ──────────────────────────────────
+   #   Similarity   File path                      Preview
+   1   0.923        ./src/config_loader.py        config loader entrypoint
+   2   0.871        ./src/utils/config_parse.py   parse config helpers
+   3   0.809        ./tests/test_config_loader.py tests for config loader
+   ```
+
+Tips:
+- Keep one index per project root; subdirectories need separate indexes only if you explicitly run `vexor index` on them.
+- Toggle `--no-recursive` (or `-n`) on both `index` and `search` when you only care about the current directory; recursive and non-recursive caches are stored separately.
+- Hidden files are included only if both `index` and `search` use `--include-hidden`.
+- Re-running `vexor index` only re-embeds files whose names changed (or were added/removed); if more than half the files differ, it automatically falls back to a full rebuild for consistency.
+- Specify the indexing mode with `--mode`; currently `name` (file names only) and `head` (first chunk of supported text/code/PDF/DOCX/etc. files) are available, each with its own cache.
+
+## Commands
+| Command | Description |
+| ------- | ----------- |
+| `vexor index --path PATH --mode MODE [--include-hidden] [--no-recursive] [--clear/--show]` | Scans `PATH` (recursively by default), embeds content according to `MODE` (`name` or `head`), and writes a cache under `~/.vexor`. |
+| `vexor search QUERY --path PATH --mode MODE [--top K] [--include-hidden] [--no-recursive]` | Loads the cached embeddings for `PATH` (matching the chosen mode/recursion/hidden settings), shows matches for `QUERY`. |
+| `vexor doctor` | Checks whether the `vexor` command is available on the current `PATH`. |
+| `vexor update` | Fetches the latest release version and shows links to update via GitHub or PyPI. |
+| `vexor config --set-api-key/--clear-api-key` | Manage the stored Gemini API key. |
+| `vexor config --set-model/--set-batch-size/--show` | Manage default model and batch size. |
+| `vexor config --show-index-all/--clear-index-all` | Inspect or delete every cached index regardless of path/mode. |

vexor-0.4.2/pyproject.toml

@@ -0,0 +1,71 @@
+
+[build-system]
+requires = ["hatchling>=1.21"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vexor"
+description = "A vector-powered CLI for semantic search over files."
+readme = "README.md"
+authors = [{ name = "scarletkc" }]
+license = { text = "MIT" }
+requires-python = ">=3.9"
+keywords = ["semantic-search", "cli", "typer", "ai"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Topic :: Utilities",
+    "Topic :: System :: Filesystems",
+    "Topic :: Text Processing :: Indexing",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+dependencies = [
+    "google-genai>=0.5.0",
+    "python-dotenv>=1.0.0",
+    "scikit-learn>=1.3.0",
+    "numpy>=1.23.0",
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+    "charset-normalizer>=3.3.0",
+    "pypdf>=4.0.0",
+    "python-docx>=0.8.11",
+]
+dynamic = ["version"]
+
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4",
+    "pytest-cov>=4.1",
+    "build>=1.2.1",
+    "twine>=5.1.1",
+]
+
+[project.urls]
+Repository = "https://github.com/scarletkc/vexor"
+
+[project.scripts]
+vexor = "vexor.cli:run"
+
+[tool.hatch.version]
+path = "vexor/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "vexor",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["vexor"]
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+pythonpath = ["."]

vexor-0.4.2/vexor/__init__.py

@@ -0,0 +1,12 @@
+"""Vexor package initialization."""
+
+from __future__ import annotations
+
+__all__ = ["__version__", "get_version"]
+
+__version__ = "0.4.2"
+
+
+def get_version() -> str:
+    """Return the current package version."""
+    return __version__

vexor-0.4.2/vexor/__main__.py

@@ -0,0 +1,18 @@
+"""Entry point for `python -m vexor` and frozen builds."""
+
+from __future__ import annotations
+
+try:
+    # Normal package execution path
+    from .cli import run
+except ImportError:  # pragma: no cover - happens in frozen single-file builds
+    from vexor.cli import run  # type: ignore[import]
+
+
+def main() -> None:
+    """Execute the Typer application."""
+    run()
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())