https://github.com/tigrisdata-archive/tigris-client-python

Python client for Tigris
https://github.com/tigrisdata-archive/tigris-client-python

database nosql python search tigris-database vector

Last synced: about 1 month ago
JSON representation

Python client for Tigris

• Host: GitHub
• URL: https://github.com/tigrisdata-archive/tigris-client-python
• Owner: tigrisdata-archive
• License: apache-2.0
• Created: 2023-04-21T01:31:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-04T18:20:18.000Z (over 1 year ago)
• Last Synced: 2024-11-02T00:08:42.944Z (about 2 months ago)
• Topics: database, nosql, python, search, tigris-database, vector
• Language: Python
• Homepage: https://www.tigrisdata.com/
• Size: 83 KB
• Stars: 4
• Watchers: 8
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tigris-client-python

Python client for Tigris

## Installation

```commandline

pip install tigrisdb

```

# Usage

Vector Search - https://www.tigrisdata.com/docs/concepts/vector-search/python/

# Development

1. Install `poetry` following the installation instructions [here](https://python-poetry.org/docs/#installation)

2. Requires **python 3.8+**, **pip 23.x**

3. Clone the repo and cd into the directory

4. Update submodule - `git submodule update --init`

5. Create and activate the virtual environment - `poetry shell`

6. Install dependencies - `poetry install --with dev`

7. [Optional] install [git hooks](#git-hooks)

8. Compile proto and generate api client helpers - `poetry run make generate`

## Git Hooks

We use [pre-commit](https://pre-commit.com/index.html) to automatically

setup and run git hooks.

On every `git commit` we check the code quality. Install the hooks:

```commandline

pre-commit install

```