fea: add support for env var CLIDRIVER_VERSION for autodownload

Author: bimalkjha

README.md

@@ -77,27 +77,45 @@ pip install ibm_db
 
 This will install ibm_db and ibm_db_dbi module.
 
-**Note:**
-When we install ibm_db package on Linux, MacOS and Windows, `pip install ibm_db` command install
-prebuilt Wheel package that includes clidriver too and ignores `IBM_DB_HOME` or `IBM_DB_INSTALLER_URL`
-environment variables if set. Also, auto downloading of clidriver does not happen as clidriver is
-already present inside wheel package.
+- When we install ibm_db package on Linux, MacOS and Windows, `pip install ibm_db` command install
+  prebuilt Wheel package that includes clidriver too and ignores `IBM_DB_HOME` or `IBM_DB_INSTALLER_URL`
+  or `CLIDRIVER_VERSION` environment variables if set. Also, auto downloading of clidriver does not happen
+  as clidriver is already present inside wheel package.
 
-To inforce auto downloading of clidriver or to make setting of environment variable `IBM_DB_HOME`
-effective, install ibm_db from source distribution using below command:
+- For platforms not supported by python-wheel, ibm_db will get installed from souce distribution.
+  GCC compiler is required on non-windows platform and VC++ compiler on Windows platform to
+  install `ibm_db` from souce distribution.
+
+- If `db2cli validate` command works in your system and installed db2 client/server
+  has `include` directory, ibm_db installation from souce distribution will not download clidriver, but
+  it will use the existing client/server from the system.
+
+- To inforce auto downloading of clidriver _OR_ to make setting of environment variable `IBM_DB_HOME` or
+  `IBM_DB_INSTALLER_URL` or `CLIDRIVER_VERSION` effective; install ibm_db from source distribution
+  using below command:
 
 ```
 pip install ibm_db --no-binary :all: --no-cache-dir
 ```
 
-If you have to use your own URL for clidriver.tar.gz/.zip please set environment variable
+- If you want to use your own URL for clidriver.tar.gz/.zip please set below environment variable:
 
 ```
-IBM_DB_INSTALLER_URL=full_path_of_clidriver.tar.gz/.zip
+export IBM_DB_INSTALLER_URL=full_path_of_clidriver.tar.gz/.zip
+pip install ibm_db --no-binary :all: --no-cache-dir
 ```
 
-When ibm_db get installed from wheel package, you can find clidriver under site_packages directory
-of Python. You need to copy license file under `site_packages/clidriver/license` to be effective, if any.
+- To install using specific version of clidriver from https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/:
+
+```
+export CLIDRIVER_VERSION=v11.5.9
+pip install ibm_db --no-binary :all: --no-cache-dir
+```
+
+- ibm_db will override value of CLIDRIVER_VERSION to v12.1.0 for MacARM64 and to v11.5.9 for Macx64 platform.
+
+- When ibm_db get installed from wheel package, you can find clidriver under site_packages directory
+  of Python. You need to copy license file under `site_packages/clidriver/license` to be effective, if any.
 
 **Note:** For windows after installing ibm_db, recieves the below error when we try to import ibm_db :
 
@@ -135,7 +153,7 @@ if pip or pip3 does not exist, install it as:
 wget https://bootstrap.pypa.io/get-pip.py
 docker cp get-pip.py /root:<containerid>
 cd root
-python2 get-pip.py or python3 get-pip.py
+python3 get-pip.py
 
 Install python ibm_db as:
 pip install ibm_db

setup.py

@@ -286,6 +286,10 @@ def print_exception( e, url):
         shutil.copy(prebuildPYDname, os.path.join(dllDir, 'ibm_db.dll'))
         prebuildIbmdbPYD = True
 
+# Get version of clidriver for autodownload from environment variable CLIDRIVER_VERSION
+# Default version is v11.5.9
+clidriver_version = os.getenv("CLIDRIVER_VERSION", "v11.5.9")
+
 if ((ibm_db_home == '') and (ibm_db_dir == '') and (ibm_db_lib == '')):
     if('win32' not in sys.platform):
         sys.stdout.write("Detected platform = " + sys.platform + ", uname = " + os.uname()[4] + "\n")
@@ -360,6 +364,11 @@ def print_exception( e, url):
             os_ = 'mac'
             cliFileName = 'macarm64_odbc_cli.tar.gz'
             arch_ = 'arm64'
+            if(clidriver_version.startswith("v11")):
+                clidriver_version = "v12.1.0"
+        else:
+            if(clidriver_version.startswith("v12")):
+                clidriver_version = "v11.5.9"
     else:
         _printAndExit("Not a known platform for python ibm_db.")
 
@@ -369,20 +378,21 @@ def print_exception( e, url):
     ibm_db_lib_runtime = os.path.join('$ORIGIN', 'clidriver', 'lib')
     ibm_db_dir = 'clidriver'
     ibm_db_lib = os.path.join(ibm_db_dir, 'lib')
+    clidriver_version = clidriver_version + "/"
 
     if not os.path.isdir('clidriver'):
         if 'IBM_DB_INSTALLER_URL' in os.environ:
             url = os.getenv('IBM_DB_INSTALLER_URL') + cliFileName
         else:
-            url = 'https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/' + cliFileName
+            url = 'https://public.dhe.ibm.com/ibmdl/export/pub/software/data/db2/drivers/odbc_cli/' + clidriver_version + cliFileName
         sys.stdout.write("Downloading %s\n" % (url))
         sys.stdout.flush()
         try:
             _downloadClidriver(url)
         except Exception as e:
             print_exception(e, url)
             try:
-                git_url= 'https://github.com/ibmdb/db2drivers/raw/main/clidriver/' + cliFileName
+                git_url= 'https://github.com/ibmdb/db2drivers/raw/main/clidriver/' + clidriver_version + cliFileName
                 _downloadClidriver(git_url)
             except Exception as e:
                 print_exception(e, git_url)