pygridgain_dbapi
GridGain 9 DB API Driver.
Prerequisites
- Python 3.9 or above (3.9, 3.10, 3.11, 3.12 and 3.13 are tested),
- Access to GridGain 9 node, local or remote.
Installation
From repository
This is a recommended way for users. If you only want to use the pygridgain_dbapi
module in your project, do:
$ pip install pygridgain-dbapi
From sources
This way is more suitable for developers, or if you install the client from zip archive.
- Download and/or unzip GridGain 9 DB API Driver sources to
pygridgain_dbapi_path
- Go to
pygridgain_dbapi_path
folder
- Execute
pip install -e .
$ cd <pygridgain_dbapi_path>
$ pip install -e .
This will install the repository version of pygridgain_dbapi
into your environment in so-called “develop” or “editable”
mode. You may read more about editable installs
in the pip
manual.
Then run through the contents of requirements
folder to install the additional requirements into your working Python
environment using
$ pip install -r requirements/<your task>.txt
You may also want to consult the setuptools
manual about using setup.py
.
C extension
The core of the package is a C++ extension. It shares the code with the GridGain C++ Client. The package is pre-built
for the most common platforms, but you may need to build it if your platform is not included.
Linux building requirements:
- GCC (and G++);
- CMake version >=3.18;
- unixODBC (dev version of the package);
- OpenSSL (dev version of the package);
- Docker to build wheels;
- Supported versions of Python (3.9, 3.10, 3.11, 3.12 and 3.13).
You can disable some of these versions, but you'd need to edit the script for that.
For building universal wheels
(binary packages) for Linux, just invoke script ./scripts/create_distr.sh
.
Windows building requirements:
- MSVC 14.x, and it should be in path;
- CMake version >=3.18;
- OpenSSL (headers are required for the build);
- Supported versions of Python (3.9, 3.10, 3.11, 3.12 and 3.13).
You can disable some of these versions, but you'd need to edit the script for that.
For building wheels
for Windows, invoke script .\scripts\BuildWheels.ps1
using PowerShell.
Make sure that your execution policy allows execution of scripts in your environment.
The script only works with Python distributions installed in a standard path, which is LOCALAPPDATA\Programs\Python.
Ready wheels will be located in distr
directory.
Updating from older version
To upgrade an existing package, use the following command:
pip install --upgrade pygridgain_dbapi
To install the latest version of a package:
pip install pygridgain_dbapi
To install a specific version:
pip install pygridgain_dbapi==9.0.15
Testing
NB! It is recommended installing pygridgain_dbapi
in development mode.
Refer to this section for instructions.
Remember to install test requirements:
$ pip install -r requirements/install.txt -r requirements/tests.txt
Run basic tests
Running tests themselves:
$ pytest
Documentation
Install documentation requirements:
$ pip install -r requirements/docs.txt
Generate documentation:
$ cd docs
$ make html
The resulting documentation can be found in docs/_build/html
. If you want to open the documentation locally, you can
open the index of the documentation docs/_build/html/index.html
using any modern browser.