Metadata-Version: 2.1
Name: pygridgain
Version: 1.3.1
Summary: GridGain binary client Python API
Home-page: https://github.com/gridgain/python-thin-client
Author: GridGain Systems
Author-email: info@gridgain.com
License: GridGain Community Edition License
Description: # pygridgain
        GridGain Community Edition thin (binary protocol) client, written in Python 3.
        
        ## Prerequisites
        
        - Python 3.4 or above (3.6 is tested),
        - Access to GridGain node, local or remote. The current thin client
          version was tested on GridGain CE 8.7 (binary client protocol versions
          1.2.0 to 1.4.0).
        
        ## Installation
        
        ### From repository
        This is a recommended way for users. If you only want to use the `pygridgain`
        module in your project, do:
        ```
        $ pip install pygridgain
        ```
        
        ### From sources
        This way is more suitable for developers or if you install client from zip archive.
        1. Download and/or unzip GridGain Python client sources to `gridgain_client_path`
        2. Go to `gridgain_client_path` folder
        3. Execute `pip install -e .`
        
        ```bash
        $ cd <gridgain_client_path>
        $ pip install -e .
        ```
        
        This will install the repository version of `pygridgain` into your environment
        in so-called “develop” or “editable” mode. You may read more about
        [editable installs](https://pip.pypa.io/en/stable/reference/pip_install/#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`.
        
        ### *optional C extension*
        There is an optional C extension to speedup some computational intensive tasks. If it's compilation fails
        (missing compiler or CPython headers), `pygridgain` will be installed without this module.
        
        - On Linux or MacOS X only C compiler is required (`gcc` or `clang`). It compiles during standard setup process.
        - For building universal `wheels` (binary packages) for Linux, just invoke script `./scripts/create_distr.sh`. 
          
          ***NB!* Docker is required.**
          
          Ready wheels for `x86` and `x86-64` for different python versions (3.6, 3.7, 3.8 and 3.9) will be
          located in `./distr` directory.
          
        
        ### Updating from older version
        
        To upgrade an existing package, use the following command:
        ```
        pip install --upgrade pygridgain
        ```
        
        To install the latest version of a package:
        
        ```
        pip install pygridgain
        ```
        
        To install a specific version:
        
        ```
        pip install pygridgain==1.2.0
        ```
        
        ## Documentation
        [The package documentation](https://pygridgain.readthedocs.io) is available
        at *RTD* for your convenience.
        
        If you want to build the documentation from source, do the developer
        installation as described above, then run the following commands:
        ```
        $ cd pygridgain
        $ pip install -r requirements/docs.txt
        $ cd docs
        $ make html
        ```
        
        Then open `pygridgain/docs/generated/html/index.html`
        in your browser.
        
        ## Examples
        Some examples of using pygridgain are provided in
        `pygridgain/examples` folder. They are extensively
        commented in the
        “[Examples of usage](https://pygridgain.readthedocs.io/en/latest/examples.html)”
        section of the documentation.
        
        This code implies that it is run in the environment with `pygridgain` package
        installed, and GridGain node is running on localhost:10800.
        
        ## Testing
        *NB!* It is recommended installing `pygridgain` in development mode.
        Refer to [this section](#for-developer) for instructions.
        
        Do not forget to install test requirements: 
        ```bash
        $ pip install -r requirements/install.txt -r requirements/tests.txt
        ```
        
        Also, you'll need to have a binary release of Ignite with `log4j2` enabled and to set
        `IGNITE_HOME` environment variable: 
        ```bash
        $ cd <ignite_binary_release>
        $ export IGNITE_HOME=$(pwd)
        $ cp -r $IGNITE_HOME/libs/optional/ignite-log4j2 $IGNITE_HOME/libs/
        ```
        ### Run basic tests
        ```bash
        $ pytest
        ```
        ### Run with examples
        ```bash
        $ pytest --examples 
        ```
        
        If you need to change the connection parameters, see the documentation on
        [testing](https://pygridgain.readthedocs.io/en/latest/readme.html#testing).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: Free for non-commercial use
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: docs
