Skip to main content

Vector-based grep tool

Project description

#+title: Vector-Grep
Sync your DB to a vector DB and perform queries.

* Installation
Install the published package with [[https://pip.pypa.io/en/stable/][pip]]:
#+begin_src shell
pip install vgrep
#+end_src

To build and install locally:
#+begin_src shell
python -m build
pip install dist/vgrep-*.whl
#+end_src

* Publishing
Releases are published to [[https://pypi.org/][PyPI]] automatically via GitHub Actions when a
GitHub release is created. Configure the repository with a
``PYPI_API_TOKEN`` secret and the workflow will build and upload the
distribution for you.

* Usage
** Command line
Sync the database with tracked folders or search for text:
#+begin_src shell
vgrep --sync
vgrep --query "search text"
#+end_src

** Library
Interact with the index programmatically:
#+begin_src python
from vgrep.db import DB

# assuming ``collection`` is a ``chromadb.Collection``
db = DB(collection)
results = db.query("needle")
#+end_src

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vgrep-0.1.0.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vgrep-0.1.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file vgrep-0.1.0.tar.gz.

File metadata

  • Download URL: vgrep-0.1.0.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vgrep-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ac597e3c02665f25de51650d4561e00fc3b9c5e49e33728a458424d3e3702f8e
MD5 2f6ad297e222f34b76e7341b23e7a40c
BLAKE2b-256 6f39159869a21f572bd8c34e8ea81ca95e85a0b6d15a0dd193564645c859308f

See more details on using hashes here.

Provenance

The following attestation bundles were made for vgrep-0.1.0.tar.gz:

Publisher: publish.yml on pierrel/vgrep

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vgrep-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vgrep-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vgrep-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a222d7de5b559b26e62f9362f0af21ae4ef354a7b9d4cf1024237ffaff97d8a
MD5 dc109088b0ff62cc32295294f5ae0438
BLAKE2b-256 1dcc968c672fb871e5efb5afcbaac9f1f16aee3d6ab642940cedffb02e5d1495

See more details on using hashes here.

Provenance

The following attestation bundles were made for vgrep-0.1.0-py3-none-any.whl:

Publisher: publish.yml on pierrel/vgrep

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page