@@ -58,53 +58,51 @@ pip install pyignite==0.4.0
5858is available at * RTD* for your convenience.
5959
6060If you want to build the documentation from source, do the developer
61- installation as described above, then run the following commands:
62- ```
63- $ cd ignite/modules/platforms/python
61+ installation as described above, then run the following commands from the
62+ client's root directory:
63+ ``` bash
6464$ pip install -r requirements/docs.txt
6565$ cd docs
6666$ make html
6767```
6868
69- Then open ` ignite/modules/platforms/python/docs/generated/html/index.html `
70- in your browser.
69+ Then open ` docs/generated/html/index.html ` in your browser.
7170
7271## Examples
73- Some examples of using pyignite are provided in
74- ` ignite/modules/platforms/python/examples ` folder. They are extensively
75- commented in the
72+ Some examples of using pyignite are provided in ` examples ` folder. They are
73+ extensively commented in the
7674“[ Examples of usage] ( https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/examples.html ) ”
7775section of the documentation.
7876
7977This code implies that it is run in the environment with ` pyignite ` package
8078installed, and Apache Ignite node is running on localhost:10800.
8179
8280## Testing
83- * NB!* All tests require Apache Ignite node running on localhost:10800. For the convenience, ` docker-compose.yml ` is present.
84- So installing ` docker ` and ` docker-compose ` is recommended. Also, it is recommended installing ` pyignite ` in development
85- mode. You can do that using following command:
86- ```
87- $ pip install -e .
88- ```
89- ### Run without ssl
81+ * NB!* It is recommended installing ` pyignite ` in development mode.
82+ Refer to [ this section] ( #for-developer ) for instructions.
83+
84+ Also, you'll need to have a binary release of Ignite with lib4j2 enabled and
85+ ` IGNITE_HOME ` properly set:
86+ ``` bash
87+ $ cd < ignite_binary_release>
88+ $ export IGNITE_HOME=$( pwd)
89+ $ cp -r libs/optional/ignite-log4j2/* libs/
9090```
91- $ docker-compose down && docker-compose up -d ignite
92- $ pytest
91+ ### Run basic tests
92+ ``` bash
93+ $ python ./setup.py pytest
9394```
9495### Run with examples
95- ```
96- $ docker-compose down && docker-compose up -d ignite
97- $ pytest --examples
96+ ``` bash
97+ $ python ./setup.py pytest --addopts=" --examples"
9898```
9999### Run with ssl and not encrypted key
100- ```
101- $ docker-compose down && docker-compose up -d ignite
102- $ pytest --use-ssl=True --ssl-certfile=./tests/config/ssl/client_full.pem
100+ ``` bash
101+ $ python ./setup.py pytest --addopts=" --use-ssl=True --ssl-certfile=./tests/ssl/client_full.pem"
103102```
104103### Run with ssl and password-protected key
105- ```
106- $ docker-compose down && docker-compose up -d ignite
107- $ pytest --use-ssl=True --ssl-certfile=./tests/config/ssl/client_with_pass_full.pem --ssl-keyfile-password=654321
104+ ``` bash
105+ $ python ./setup.py pytest --addopts=" --use-ssl=True --ssl-certfile=./tests/config/ssl/client_with_pass_full.pem --ssl-keyfile-password=654321"
108106```
109107
110108If you need to change the connection parameters, see the documentation on
0 commit comments