Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.56 KB

DEVELOPING.md

File metadata and controls

50 lines (36 loc) · 1.56 KB

Developing Coherence Python Client

Pre-Requisites

  • Use bash shell
  • pyenv version 2.3.x or later
  • poetry version 1.5.x or later

Project Structure

  • bin - various shell scripts
  • etc - contains the ProtoBuff .protoc files and other various files
  • coherence - Python source files and related resources
  • tests - contains the library test cases in plain Python

Setup working environment

  1. Install Python version 3.11.3

    pyenv install 3.11.3

  2. Checkout the source from GitHub and change directory to the project root dir

  3. Set pyenv local version for this project to 3.11.3

    pyenv local 3.11.3

  4. Set poetry to use python 3.11.3

    poetry env use 3.11.3

  5. Install all the required dependencies using poetry

    poetry install

  6. For setting up IntelliJ IDE, install the Python and PyEnv plugins

  7. Get the full path of the poetry/python virtualenv

    poetry env list --full-path

  8. Use the path above to setup the project settings in IntelliJ IDE. See this

    Use the Existing Environment option to use the path above

Note: Incase one needs to re-generate the sources from .proto files, make sure steps 1-5 are done. Run the Makefile in the virtualenv shell:

poetry shell
make generate-proto