feat: Initial setup for py client (#2)

tigrisdata-archive · Apr 24, 2023 · d087dfd · d087dfd
1 parent 25babb3
commit d087dfd
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,3 +127,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# editor
+.idea/
+
+# generated
+generated-src/
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "api/proto"]
+	path = api/proto
+	url = git@github.com:tigrisdata/tigris-api.git
diff --git a/Makefile b/Makefile
@@ -0,0 +1,12 @@
+PROTO_PATH=./api/proto
+PROTO_FILE_PATH=${PROTO_PATH}/server/v1
+GENERATED_DIR=./generated-src/
+
+clean:
+	rm -rf ${GENERATED_DIR}
+
+generate:
+	mkdir -p ${GENERATED_DIR}
+	for pf in 'api.proto' 'search.proto' ; do \
+		python -m grpc_tools.protoc -I ${PROTO_PATH} --python_out=${GENERATED_DIR} --grpc_python_out=${GENERATED_DIR} ${PROTO_FILE_PATH}/$${pf} ; \
+	done
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
 # 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`
diff --git a/api/proto b/api/proto
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+grpcio-tools==1.54.0
+protobuf==4.22.3
diff --git a/tigris/__init__.py b/tigris/__init__.py
diff --git a/tigris/client.py b/tigris/client.py