IGNITE-17494 use_ssl is not set when auth used (#55)
[ignite-python-thin-client.git] / README.md
index 47bd7120b0b6564e287b48f9df2914c2f77c5b63..be5fa7bafd608b3695bf1b7da076a1dfbd3614ce 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,9 +3,9 @@ Apache Ignite thin (binary protocol) client, written in Python 3.
 
 ## Prerequisites
 
-- Python 3.4 or above (3.6, 3.7 and 3.8 are tested),
+- Python 3.7 or above (3.7, 3.8, 3.9 and 3.10 are tested),
 - Access to Apache Ignite node, local or remote. The current thin client
-  version was tested on Apache Ignite 2.7.0 (binary client protocol 1.2.0).
+  version was tested on Apache Ignite 2.10 (binary client protocol 1.7.0).
 
 ## Installation
 
@@ -45,9 +45,13 @@ There is an optional C extension to speedup some computational intensive tasks.
   
   ***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.
+- On Windows MSVC 14.x required, and it should be in path, also python versions 3.7, 3.8, 3.9 and 3.10 both for x86 and
+  x86-64 should be installed. You can disable some of these versions but you'd need to edit script for that.
+- For building `wheels` for Windows, invoke script `.\scripts\BuildWheels.ps1` using PowerShell. Just make sure that
+  your execution policy allows execution of scripts in your environment.
   
+  Ready wheels for `x86` and `x86-64` for different python versions (3.7, 3.8, 3.9 and 3.10) will be
+  located in `distr` directory.
 
 ### Updating from older version
 
@@ -63,7 +67,7 @@ pip install pyignite
 
 To install a specific version:
 ```bash
-pip install pyignite==0.4.0
+pip install pyignite==0.5.1
 ```
 
 ## Documentation
@@ -99,8 +103,8 @@ Do not forget to install test requirements:
 $ pip install -r requirements/install.txt -r requirements/tests.txt
 ```
 
-Also, you'll need to have a binary release of Ignite with lib4j2 enabled and
-`IGNITE_HOME` properly set
+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)
@@ -114,14 +118,6 @@ $ pytest
 ```bash
 $ pytest --examples 
 ```
-### Run with ssl and not encrypted key
-```bash
-$ pytest --use-ssl=True --ssl-certfile=./tests/ssl/client_full.pem
-```
-### Run with ssl and password-protected key
-```bash
-$ pytest --use-ssl=True --ssl-certfile=./tests/config/ssl/client_with_pass_full.pem --ssl-keyfile-password=654321
-```
 
 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).