Skip to content

Latest commit

 

History

History
202 lines (160 loc) · 6.54 KB

LocalBuildWindows.md

File metadata and controls

202 lines (160 loc) · 6.54 KB

Windows build

Prerequisite:
  • Python 2.7 or above or Python 3.4 or above
  • If Python 2.7 then Visual Studio 2008 or above
  • If Python 3.x then Visual Studio 2015 or above
  • Informix Client SDK(CSDK) 4.10.xC2 or above for 32-bit platforms. Its optional for 64-bit platforms, for 64-bit platforms build phase will take care of resolving dependencies on CSDK/ODBC.
  • setuptools
  • pip
  • wheel
  • twine

You may need pip version version 10.0.1 or higher, if not upgrade

python -m pip install --upgrade pip

Clone the source code

Let's assume C:\work is the location when we clone the IfxPy repository.
(You may clone it at any location though; if so make adjustment for the instructions as well).

cd C:\work

git clone https://github.com/OpenInformix/IfxPy.git

Shell Environment needed for the build

Set CSDK_HOME(Optional, see below) and MY_PY_DIR environment variables.
The environment CSDK_HOME points to the Informix Client SDK. If you don't have CSDK installed, in the build phase it will download/install CSDK/ODBC in the MY_PY_DIR\build\lib.win* folder "onedb-odbc-driver" and internally will be set to CSDK_HOME. The environment MY_PY_DIR points to the Python source code installation.

Python 2.7 build shell environment

# Open VS2008 (or latest) command windows
# set VS90COMNTOOLS if you are using latest vs, for eg, vs2015 then
SET VS90COMNTOOLS=%VS140COMNTOOLS%

SET CSDK_HOME=c:\informix
SET MY_PY_DIR=C:\Dev\Python27

FYI: While running setup.py for package build, Python 2.7 searches for an installed Visual Studio 2008. (The installation path of VS2008 is stored in the variable VS90COMNTOOLS). The general pattern for VS installation path is

VS<internal version number>COMNTOOLS.

That means if you are using higher version of VS then you may map VSxxCOMNTOOLS for that VS to VS90COMNTOOLS.

#For example:   
#If you are using Visual Studio 2010 (VS10):  
SET VS90COMNTOOLS=%VS100COMNTOOLS%
  
#If you are using Visual Studio 2012 (VS11):   
SET VS90COMNTOOLS=%VS110COMNTOOLS%
  
#If you are using Visual Studio 2013 (VS12):   
SET VS90COMNTOOLS=%VS120COMNTOOLS%
  
#If you are using Visual Studio 2015 (VS14):   
SET VS90COMNTOOLS=%VS140COMNTOOLS%
  
#If you are using Visual Studio 2017 (VS15):   
SET VS90COMNTOOLS=%VS150COMNTOOLS%

Python 3.x build shell environment

The Python 3.x build uses Visual Studio 2015 or above then, if you are building with python 3.x then make your you have VS2015 or above available on your system.

# Open VS2015 (or latest) command windows

SET CSDK_HOME=c:\informix
SET MY_PY_DIR=C:\Dev\Anaconda

Starting the build

# common for Python 2.7 and 3.x
cd C:\work\IfxPy\IfxPy
python setup.py build > out.txt 2>&1

# On successful build Advanced native extension module (**IfxPy.pyd**) should have built, and it is
# C:\work\IfxPy\IfxPy\build\lib.win-amd64-2.7\IfxPy.pyd
# C:\work\IfxPy\IfxPy\build\lib.win-amd64-3.6\IfxPy.cp36-win_amd64.pyd

Other Build Options

# Make sure you have installed wheel before doing the build
pip install wheel

cd C:\work\IfxPy\IfxPy
python setup.py bdist_wheel

# On successful build, it would have created the whl file under dist folder. 
# For example : 
# C:\work\IfxPy\IfxPy\dist\IfxPy-3.0.1-cp36-cp36m-win_amd64.whl

# YOu may use pip intall to install the driver from the whl file
#  it will get distributed to your <Python Install Directory>\Lib\site-packages\
# pip install  dist\IfxPy-<driver version>-cp36-cp36m-win_amd64.whl
# For example:
pip install  dist\IfxPy-3.0.1-cp36-cp36m-win_amd64.whl
Post successful installation of wheel file, you would see "onedb-odbc-driver" in the "site-packages" directory. The "onedb-odbc-driver" could be used to set the value of INFORMIXDIR for runtime.

Install

The python documentation has various python package install options, you may choose any of the option.

If you are looking for a simple build test verification only situation, then you may manually copy Informix python modules (IfxPy.pyd and IfxPyDbi.py) to your Python application module directory.

# if Python 2.7 on Win64 then
COPY  C:\work\IfxPy\IfxPy\build\lib.win-amd64-2.7\IfxPy.pyd

# if Python 3.6 on Win64 then
COPY  C:\work\IfxPy\IfxPy\build\lib.win-amd64-3.6\IfxPy.cp36-win_amd64.pyd

Get a sample application to try it out

cd C:\work\IfxPy\try
######### copy sample application source ####################
copy C:\work\IfxPy\Examples\Sample1.py  Sample.py

Copy the Driver

Copy the Advanced native extension module

If Python 2.7 then

# Python Database API Specification v2.0 API extension module
# it is common for bot 2.7 and 3.x
copy C:\work\IfxPy\IfxPy\IfxPyDbi.py

############ Advanced native extension module ############
# from local build
# if you have already done a build then only
copy  C:\work\IfxPy\IfxPy\build\lib.win-amd64-2.7\IfxPy.pyd

# or from prebuilt
# A prebuilt binary of the driver Advanced native extension module is available
# it can be unzip to get it going.
copy C:\work\IfxPy\prebuilt\27x\Win64\IfxPy.zip
# unzip it

If Python 3.x then

For Python 3.x there are two types of prebuilt driver binaries available

  • Created a zip of the driver binaries that you can unzip it.
  • A Python wheel package that can be installed.

if you have local build and copying the binary then

COPY  C:\work\IfxPy\IfxPy\build\lib.win-amd64-3.6\IfxPy.cp36-win_amd64.pyd
copy C:\work\IfxPy\IfxPy\IfxPyDbi.py

prebuilt binary zip

COPY  C:\work\IfxPy\prebuilt\3x\Win64\IfxPy.zip
# then unzip it

prebuilt wheel package

pip install C:\work\IfxPy\prebuilt\3x\Win64\IfxPy-3.0.1-cp36-cp36m-win_amd64.whl

Running the sample application

set PATH=C:\Informix\bin;%PATH%

# Edit Sample.py connection information, and then run
python Sample.py

PyPi upload

# After successful wheel build, then 
# cd C:\work\IfxPy\IfxPy
twine upload dist/*