Skip to content

Commit

Permalink
Make Windows installation a separate item, since a binary build is av…
Browse files Browse the repository at this point in the history
…ailable
  • Loading branch information
MathMagique committed Apr 6, 2017
1 parent facee69 commit d9291a3
Showing 1 changed file with 31 additions and 15 deletions.
46 changes: 31 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,32 +27,48 @@ Features
* Tested on 64 bit versions of Linux, OSX, and Windows (Python 3.5+).


Installation
------------
Installation (Linux and OSX)
----------------------------

To install turbodbc, please use the following command:
To install turbodbc on Linux and OSX, please use the following command:

pip install turbodbc

On Windows, this will download and install a precompiled Python package. On Linux
and OSX, this will trigger a source build. If you want to leverage turbodbc's
NumPy support, please make sure to `pip install numpy`
before installing turbodbc. Turbodbc searches for NumPy headers
at installation time to determine whether NumPy support can be provided.
This will trigger a source build that requires compiling C++ code. Please make sure
the following prerequisites are met:

Compiling turbodbc yourself requires the following prerequisites:
Requirement | Linux (`apt-get install`) | OSX (`brew install`) |
----------------------------|---------------------------|------------------------|
C++11 compiler | G++-4.8 or higher | clang with OSX 10.9+ |
Boost library + headers (1) | `libboost-all-dev` | `boost` |
ODBC library + headers | `unixodbc-dev` | `unixodbc` |
Python headers | `python-dev` | use `pyenv` to install |

Requirement | Linux (`apt-get install`) | OSX (`brew install`) | Windows |
----------------------------|---------------------------|------------------------|------------------------|
C++11 compiler | G++-4.8 or higher | clang with OSX 10.9+ | Visual C++ 2015 |
Boost library + headers (1) | `libboost-all-dev` | `boost` | Boost sources |
ODBC library + headers | `unixodbc-dev` | `unixodbc` | Windows Kits |
Python headers | `python-dev` | use `pyenv` to install | Python 3.5+ |
Please `pip install numpy` before installing turbodbc, because turbodbc will search
for the `numpy` Python package at installation/compile time. If NumPy is not installed,
turbodbc will not compile the optional NumPy support features.

(1) The minimum viable Boost setup requires the libraries `variant`, `optional`,
`datetime`, and `locale`.


Installation (Windows)
----------------------

To install turbodbc on Windows, please use the following command:

pip install turbodbc

This will download and install a binary wheel, no compilation required. You still need
to meet the following prerequisites, though:

Requirement | Windows |
------------|---------------------------------------------------------------------------------------------------------------|
OS Bitness | 64-bit |
Python | 3.5 or 3.6, 64-bit |
Runtime | [MSVS 2015 Update 3 Redistributable, 64 bit](https://www.microsoft.com/en-us/download/details.aspx?id=53840) |


Why should I use turbodbc instead of other ODBC modules?
--------------------------------------------------------

Expand Down

0 comments on commit d9291a3

Please sign in to comment.