Skip to content

Commit

Permalink
feat: add poetry for package management (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
ovaistariq committed May 10, 2023
1 parent d087dfd commit fae8f7e
Show file tree
Hide file tree
Showing 4 changed files with 192 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# tigris-client-python

Python client for Tigris

# Development
1. Requires **python 3.7+**, **pip 23.x**
2. Clone the repo and cd into the directory
3. Update submodule - `git submodule --init`
4. Install virtualenv - `pip install virtualenv`
5. Create virtualenv in the project directory - `virtualenv venv`
6. Activate virtualenv - `. venv/bin/activate`
7. Install dependencies - `pip install -r requirements.txt`
8. Compile proto and generate api client helpers - `make generate`

1. Install `poetry` following the installation instructions [here](https://python-poetry.org/docs/#installation)
2. Requires **python 3.7+**, **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`
7. Compile proto and generate api client helpers - `make generate`
164 changes: 164 additions & 0 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions poetry.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[virtualenvs]
in-project = true
17 changes: 17 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[tool.poetry]
name = "tigris"
version = "0.1.0"
description = "Python SDK for Tigris <http://www.tigrisdata.com>"
authors = ["Tigris team <support@tigrisdata.com>"]
license = "Apache-2.0"
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.7"
grpcio-tools = "^1.54.0"
protobuf = "^4.22.3"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

0 comments on commit fae8f7e

Please sign in to comment.