If you want to help with bug fixes, develop new features or tweak the implementation to your application’s needs, you can follow the steps in this section.
Follow the below steps to build and install Hazelcast Python client from its source:
- Clone the GitHub repository (https://github.com/hazelcast/hazelcast-python-client.git).
- Run
python setup.py install
to install the Python client.
If you are planning to contribute:
- Run
pip install -r requirements-dev.txt
to install development dependencies. - Use black to reformat the code by running the
black --config black.toml .
command. - Make sure that tests are passing by following the steps described in the
development_and_testing:testing
section.
In order to test Hazelcast Python client locally, you will need the following:
- Java 8 or newer
- Maven
Following commands starts the tests according to your operating system:
bash run-tests.sh
or
.\run-tests.ps1
Test script automatically downloads hazelcast-remote-controller
and Hazelcast IMDG. The script uses Maven to download those.