Metadata-Version: 2.1
Name: pyignite
Version: 0.1.3
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
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
Requires-Dist: attrs (==18.1.0)
Provides-Extra: docs
Requires-Dist: Sphinx (==1.7.5); extra == 'docs'

# ignite-python-client
Apache Ignite binary protocol client, written in Python 3.

## Requirements

### *for using:*
- Python 3.4+
- attrs

### *for testing:*
- pytest
- pytest-runner
- pytest-cov

### *for building documentation:*
- Sphinx

## Installation
If you only want to use the `pyignite` module in your project, do:
```
$ pip install pyignite
```

If you want also run tests and build documentation, clone the whole
repository:
```
$ git clone git@github.com:nobitlost/ignite.git
$ git checkout ignite-7782
$ cd ignite/modules/platforms/python
```

You may consult `distutils` manual about using `setup.py`.

## Documentation
Run
```
$ cd ignite/modules/platforms/python/docs
$ make html
```

Then open `docs/_build/html/index.html` in your browser.

## Tests
Run
```
$ cd ignite/modules/platforms/python
$ python setup.py pytest
```

*NB!* Some tests require Apache Ignite node running on localhost:10800.
To override the default parameters, use command line options
`--ignite-host` and `--ignite-port`:
```
$ python setup.py pytest --addopts "--ignite-host=example.com --ignite-port=19840"
```

You can use each of these options multiple times. All combinations
of given host and port will be tested.


