Metadata-Version: 2.1
Name: pyignite
Version: 0.1.7
Summary: Apache Ignite binary client Python API
Home-page: https://github.com/nobitlost/ignite/tree/ignite-7782/modules/platforms/python
Author: Dmitry Melnichuk
Author-email: dmitry.melnichuk@nobitlost.com
License: UNKNOWN
Description: # ignite-python-client
        Apache Ignite thin (binary protocol) client, written in Python 3.
        
        ## Prerequisites
        
        - Python 3.4 or above (3.6 is tested),
        - Access to Apache Ignite node, local or remote. The current thin client
          version was tested on Apache Ignite 2.5.
        
        ## Installation
        
        #### *for end user*
        If you only want to use the `pyignite` module in your project, do:
        ```
        $ pip install pyignite
        ```
        
        #### *for developer*
        If you want to run tests, examples or build documentation, clone
        the whole repository:
        ```
        $ git clone git@github.com:nobitlost/ignite.git
        $ git checkout ignite-7782
        $ cd ignite/modules/platforms/python
        $ pip install -e .
        ```
        
        This will install the repository version of `pyignite` 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`.
        
        ## Documentation
        [The package documentation](https://apache-ignite-binary-protocol-client.readthedocs.io)
        is available at *RTD* for your convenience.
        
        If you want to build the documentation from source, do the developer
        installation as described abothe, then run the following commands:
        ```
        $ cd ignite/modules/platforms/python
        $ pip install -r requirements/docs.txt
        $ cd docs
        $ make html
        ```
        
        Then open `ignite/modules/platforms/python/docs/generated/html/index.html`
        in your browser.
        
        ## Examples
        Some examples of using pyignite are provided in
        `ignite/modules/platforms/python/examples` folder. They are extensively
        commented in the
        “[Examples of usage](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/examples.html)”
        section of the documentation.
        
        This code implies that it is run in the environment with `pyignite` package
        installed, and Apache Ignite node is running on localhost:10800.
        
        ## Testing
        Run
        ```
        $ cd ignite/modules/platforms/python
        $ python setup.py pytest
        ```
        
        *NB!* All tests require Apache Ignite node running on localhost:10800.
        If you need to change the connection parameters, see the documentation on
        [testing](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/readme.html#testing).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: docs
