Metadata-Version: 2.1
Name: tigrisdb
Version: 1.0.0b3
Summary: Python SDK for Tigris <http://www.tigrisdata.com>
Home-page: https://www.github.com/tigrisdata/tigris-client-python
License: Apache-2.0
Keywords: database,nosql,vector,search
Author: Tigris team
Author-email: support@tigrisdata.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Database
Requires-Dist: grpcio-tools (>=1.54.0,<2.0.0)
Requires-Dist: protobuf (>=4.22.3,<5.0.0)
Project-URL: Documentation, https://www.tigrisdata.com/docs/
Project-URL: Repository, https://www.github.com/tigrisdata/tigris-client-python
Description-Content-Type: text/markdown

# tigris-client-python

Python client for Tigris

## Installation

```commandline
pip install tigrisdb
```

# Usage

See reference implementation in `./tests` directory that uses Tigris on `localhost:8081`

# 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
```

