Protobuf metadata (#94)

* proto metadata first setup

* cleanup

* cleanup & structured transaction async response

* fix

* get protobuf metadata function

* adding v2 show results

* fix name & filename content disposition regular expressions

* txn to txn_file

* adding integration tests

* cleanup

* adding ci workflow

* fix yaml

* typo

* adding check for proto generated code

* align python version with README

* enable flake8 linter

* fix linter

* updating readme

Author: NRHelmi

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+ignore = F811, E501
+exclude = env,.git,__pycache__,railib/pb,build,dist
+max-line-length = 79
+max-complexity = 18
+

.github/workflows/build.yaml

@@ -0,0 +1,38 @@
+name: Build
+
+on:
+  push:
+  schedule:
+    - cron: '30 5 * * *'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Initialize Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+        pip install -r requirements.txt
+        pip install -e ./
+
+    - name: Generate Protobuf
+      run: python -m grpc_tools.protoc -I railib/pb --python_out=./railib/pb railib/pb/*.proto
+
+    - name: flake8 linter
+      run: flake8 .
+
+    - name: test
+      env:
+        CLIENT_ID: ${{ secrets.CLIENT_ID }}
+        CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
+        CLIENT_CREDENTIALS_URL: ${{ secrets.CLIENT_CREDENTIALS_URL }}
+      run: |
+        python tests/integration.py

.gitignore

@@ -5,4 +5,5 @@
 __pycache__
 build/
 dist/
+env/
 rai_sdk.egg-info/

README.md

@@ -1,5 +1,10 @@
 # The RelationalAI Software Development Kit for Python
 
+| Workflow | Status |
+| --------------------------- | ---------------------------------------------------------------------- |
+| Continuous Integration (CI) | ![build](https://github.com/RelationalAI/rai-sdk-python/actions/workflows/build.yaml/badge.svg) |
+| [Publish to PYPI](https://pypi.org/project/rai-sdk/) | ![publish](https://github.com/RelationalAI/rai-sdk-python/actions/workflows/publish.yaml/badge.svg) |
+
 The RelationalAI (RAI) SDK for Python enables developers to access the RAI
 REST APIs from Python.
 
@@ -35,6 +40,7 @@ Install from source in `editable` mode.
 ```console
 $ git clone git@github.com:RelationalAI/rai-sdk-python.git
 $ cd rai-sdk-python
+$ [sudo] pip install -r requirements.txt
 $ [sudo] pip install -e .
 ```
 
@@ -79,6 +85,12 @@ config file.
 
 You can copy `config.spec` from the root of this repo and modify as needed.
 
+## Generate python protobuf sources from protobuf specification
+
+```shell
+python -m grpc_tools.protoc -I railib/pb --python_out=./railib/pb railib/pb/*.proto
+```
+
 ## Examples
 
 Each of the example files in the `./examples` folder is standalone and can be

examples/__init__.py

@@ -30,8 +30,7 @@ def run(id: str, profile: str):
 if __name__ == "__main__":
     p = ArgumentParser()
     p.add_argument("id", type=str, help="transaction id")
-    p.add_argument("-p", "--profile", type=str,
-                   help="profile name", default="default")
+    p.add_argument("-p", "--profile", type=str, help="profile name", default="default")
     args = p.parse_args()
     try:
         run(args.id, args.profile)

examples/cancel_transaction.py

@@ -13,7 +13,7 @@
 # limitations under the License
 
 """Clone an existing database by creating a new database and setting the
-optional api.create_database `source` argument to the name of the database 
+optional api.create_database `source` argument to the name of the database
 to clone."""
 
 from argparse import ArgumentParser
@@ -34,7 +34,6 @@ def run(database: str, source: str, profile: str):
     p = ArgumentParser()
     p.add_argument("database", type=str, help="database name")
     p.add_argument("source", type=str, help="name of database to clone")
-    p.add_argument("-p", "--profile", type=str,
-                   help="profile name", default="default")
+    p.add_argument("-p", "--profile", type=str, help="profile name", default="default")
     args = p.parse_args()
     run(args.database, args.source, args.profile)

examples/clone_database.py

@@ -30,8 +30,7 @@ def run(database: str, profile: str):
 if __name__ == "__main__":
     p = ArgumentParser()
     p.add_argument("database", type=str, help="database name")
-    p.add_argument("-p", "--profile", type=str,
-                   help="profile name", default="default")
+    p.add_argument("-p", "--profile", type=str, help="profile name", default="default")
     args = p.parse_args()
     try:
         run(args.database, args.profile)

examples/create_database.py

@@ -42,10 +42,8 @@ def run(engine: str, size: str, profile: str):
 if __name__ == "__main__":
     p = ArgumentParser()
     p.add_argument("engine", type=str, help="engine name")
-    p.add_argument("--size", type=str, default="XS",
-                   help="engine size (default: XS)")
-    p.add_argument("-p", "--profile", type=str,
-                   help="profile name", default="default")
+    p.add_argument("--size", type=str, default="XS", help="engine size (default: XS)")
+    p.add_argument("-p", "--profile", type=str, help="profile name", default="default")
     args = p.parse_args()
     try:
         run(args.engine, args.size, args.profile)

examples/create_engine.py

@@ -35,12 +35,14 @@ def run(name: str, permissions: List[str], profile: str):
     p = ArgumentParser()
     p.add_argument("name", type=str, help="OAuth client name")
     perms = "', '".join(Permission)
-    p.add_argument("--permissions", nargs="*",
-                   help="OAuth client permissions. By default it will be "
-                        "assigned the same permissions as the creating entity "
-                        "(user or OAuth client). Available: '{0}'".format(perms))
-    p.add_argument("-p", "--profile", type=str,
-                   help="profile name", default="default")
+    p.add_argument(
+        "--permissions",
+        nargs="*",
+        help="OAuth client permissions. By default it will be "
+        "assigned the same permissions as the creating entity "
+        "(user or OAuth client). Available: '{0}'".format(perms),
+    )
+    p.add_argument("-p", "--profile", type=str, help="profile name", default="default")
     args = p.parse_args()
     try:
         run(args.name, args.permissions, args.profile)