Update Python library setup

Author: lpabon

.gitignore

@@ -7,3 +7,4 @@ sdk/js/package-lock.json
 sdk/python/dist/
 sdk/python/libopenstorage_openstorage.egg-info/
 sdk/python/setup.py
+api.proto

sdk/python/Makefile

@@ -2,15 +2,18 @@ APIDIR := ../..
 VEDIR := build
 PYTHON := python3
 PIP := pip3
+PATCH :=
 all: grpc
 
 ifndef APIVER
 	$(error Must provide an APIVER value)
 endif
 
 grpc:
+	-sudo rm -rf $(VEDIR) > /dev/null 2>&1
 	$(PYTHON) -m venv $(VEDIR)
 	bash -c "source $(VEDIR)/bin/activate && \
+	$(PIP) install --upgrade pip && \
 	$(PIP) install -r requirements.txt && \
 	$(PYTHON) -m grpc_tools.protoc \
 		-I$(APIDIR) \
@@ -34,10 +37,17 @@ grpc:
 		--grpc_python_out=. \
 		$(GOPATH)/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api/http.proto"
 	sed -i -e "s#^import api_pb2 as api__pb2#from openstorage import api_pb2 as api__pb2#" openstorage/api_pb2_grpc.py
-	sed -e "s#%%APIVER%%#$(APIVER)#" setup.py.tmpl > setup.py
+	sed -e "s#%%APIVER%%#$(APIVER)$(PATCH)#" setup.py.tmpl > setup.py
 	bash -c "source $(VEDIR)/bin/activate && \
 		$(PYTHON) setup.py sdist bdist_egg"
 
+release:
+	$(PYTHON) -m venv release
+	bash -c "source release/bin/activate && \
+		python3 -m pip install --upgrade pip && \
+		python3 -m pip install --upgrade twine"
+
+
 clean:
 	sudo rm -rf $(VEDIR) setup.py dist libopenstorage_openstorage.egg-info
 

sdk/python/README.md

@@ -1,27 +1,10 @@
-# Python gRPC Client Library
+# Python gRPC Client Library for OpenStorage SDK
 
-# Build
-
-Type `make`.
-
-# Installing
-
-Installing through pip is now supported:
-
-```
-   python3 -m venv sdk
-   source sdk/bin/activate
-   pip3 install libopenstorage-openstorage
-```
-
-> NOTE: Python 2.7 is no longer supported. This is for Python3 only.
+For more information please see https://libopenstorage.github.io
 
 # Example
 
 ```python
-#
-# More info: https://grpc.io/docs/quickstart/python.html
-#
 import grpc
 
 from openstorage import api_pb2
@@ -48,11 +31,6 @@ try:
     ))
     print('Volume id is {0}'.format(v_resp.volume_id))
 except grpc.RpcError as e:
-    print('Failed: code={0} msg={1}'.format(e.code(), e.details()))(build)
+    print('Failed: code={0} msg={1}'.format(e.code(), e.details()))
 ```
 
-# PyPi
-
-See https://dzone.com/articles/executable-package-pip-install
-
-

sdk/python/dev.md

@@ -0,0 +1,26 @@
+# Pypi Release
+
+* Read https://packaging.python.org/en/latest/tutorials/packaging-projects/
+
+* Type: `make release` to setup the venv
+* Type: `source release/bin/activate`
+
+Then follow the documentation from the page above to push your change to the
+testpypi server.
+
+Once you have tested that you can install from testpypi, then you can push
+to normal pypi with the command:
+
+```
+python3 -m twine upload dist/*
+```
+
+> NOTE: You will need to setup your $HOME/.pypirc with the API tokens for both
+> the testpypi and pypi servers.
+
+
+## Patch Number
+
+If during the testing you find an error and fix it, then you will want to add
+a PATCH number of ".1", and so on to the value of PATCH in the Makefile. This is
+due to pypi or testpypi not allowing uploads to get overwritten.

sdk/python/pypi.md

@@ -1,12 +1,12 @@
 cachetools==5.2.0
-certifi==2022.6.15
-charset-normalizer==2.1.0
-google-auth==2.9.1
-grpcio==1.26.0
-grpcio-tools==1.26.0
+certifi==2022.6.15.1
+charset-normalizer==2.1.1
+google-auth==2.11.0
+grpcio==1.48.1
+grpcio-tools==1.48.1
 idna==3.3
 kubernetes==24.2.0
-oauthlib==3.2.0
+oauthlib==3.2.1
 protobuf==3.20.1
 pyasn1==0.4.8
 pyasn1-modules==0.2.8
@@ -16,5 +16,5 @@ requests==2.28.1
 requests-oauthlib==1.3.1
 rsa==4.9
 six==1.16.0
-urllib3==1.26.11
-websocket-client==1.3.3
+urllib3==1.26.12
+websocket-client==1.4.1

sdk/python/requirements.txt

@@ -1,15 +1,16 @@
 import setuptools
 
-with open("pypi.md", "r") as fh:
-    long_description = fh.read()
+def read(fname):
+	with open(fname, "r") as fh:
+		return fh.read()
 
 setuptools.setup(
         name="libopenstorage-openstorage",
         version="%%APIVER%%",
         author="Portworx",
         author_email="lpabon@purestorage.com",
         description="OpenStorage SDK Python gRPC Client Library",
-        long_description=long_description,
+        long_description=read("README.md"),
         long_description_content_type="text/markdown",
         url="https://github.com/libopenstorage/openstorage-sdk-clients",
         packages=setuptools.find_packages(),
@@ -19,6 +20,6 @@ setuptools.setup(
             "License :: OSI Approved :: Apache Software License",
             "Operating System :: OS Independent",
         ],
-        python_requires='>=3.0',
+        python_requires='>=3.5',
 )