# 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
```
Raw data
{
"_id": null,
"home_page": "https://www.github.com/tigrisdata/tigris-client-python",
"name": "tigrisdb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "database,nosql,vector,search",
"author": "Tigris team",
"author_email": "support@tigrisdata.com",
"download_url": "https://files.pythonhosted.org/packages/9d/03/9069979ef2bfefa45fae9a27e76d8e85bc2114a0397f5c8f9427fb061e62/tigrisdb-1.0.0b6.tar.gz",
"platform": null,
"description": "# tigris-client-python\n\nPython client for Tigris\n\n## Installation\n\n```commandline\npip install tigrisdb\n```\n\n# Usage\n\nVector Search - https://www.tigrisdata.com/docs/concepts/vector-search/python/\n\n\n# Development\n\n1. Install `poetry` following the installation instructions [here](https://python-poetry.org/docs/#installation)\n2. Requires **python 3.8+**, **pip 23.x**\n3. Clone the repo and cd into the directory\n4. Update submodule - `git submodule update --init`\n5. Create and activate the virtual environment - `poetry shell`\n6. Install dependencies - `poetry install --with dev`\n7. [Optional] install [git hooks](#git-hooks)\n8. Compile proto and generate api client helpers - `poetry run make generate`\n\n## Git Hooks\n\nWe use [pre-commit](https://pre-commit.com/index.html) to automatically\nsetup and run git hooks.\n\nOn every `git commit` we check the code quality. Install the hooks:\n\n```commandline\npre-commit install\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python SDK for Tigris <http://www.tigrisdata.com>",
"version": "1.0.0b6",
"project_urls": {
"Documentation": "https://www.tigrisdata.com/docs/",
"Homepage": "https://www.github.com/tigrisdata/tigris-client-python",
"Repository": "https://www.github.com/tigrisdata/tigris-client-python"
},
"split_keywords": [
"database",
"nosql",
"vector",
"search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2b139b47da56e42ad72814dae89e36cb96ea7ff75a0672b92b159bcc4d63f2f",
"md5": "7db8f0616c056c99fab30d4d28184dfd",
"sha256": "8d316a61df0df09f6a269be729f8077af965d6bc39f6a00b60d3ffcb57f9d80b"
},
"downloads": -1,
"filename": "tigrisdb-1.0.0b6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7db8f0616c056c99fab30d4d28184dfd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 66930,
"upload_time": "2023-06-04T18:20:21",
"upload_time_iso_8601": "2023-06-04T18:20:21.542155Z",
"url": "https://files.pythonhosted.org/packages/b2/b1/39b47da56e42ad72814dae89e36cb96ea7ff75a0672b92b159bcc4d63f2f/tigrisdb-1.0.0b6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d039069979ef2bfefa45fae9a27e76d8e85bc2114a0397f5c8f9427fb061e62",
"md5": "eb8be3f24eef6245f4871768e9db3768",
"sha256": "5160b3379aaa379fa4194c3e5d549e8be723aab922991021b8c0afd340ff14f5"
},
"downloads": -1,
"filename": "tigrisdb-1.0.0b6.tar.gz",
"has_sig": false,
"md5_digest": "eb8be3f24eef6245f4871768e9db3768",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 53030,
"upload_time": "2023-06-04T18:20:23",
"upload_time_iso_8601": "2023-06-04T18:20:23.342529Z",
"url": "https://files.pythonhosted.org/packages/9d/03/9069979ef2bfefa45fae9a27e76d8e85bc2114a0397f5c8f9427fb061e62/tigrisdb-1.0.0b6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-04 18:20:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tigrisdata",
"github_project": "tigris-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tigrisdb"
}
JSON
