Google Git
Sign in
apache / incubator-resilientdb-python-sdk / a0d19cee919f3e44946a23f18cc97fab98c76e48
commita0d19cee919f3e44946a23f18cc97fab98c76e48[log] [tgz]
authorAlphaRoy14 <AlphaRoy14@gmail.com>Thu Oct 03 00:48:15 2024 -0400
committerAlphaRoy14 <AlphaRoy14@gmail.com>Thu Oct 03 00:48:15 2024 -0400
tree99cac602382c2911eabc4d1798f9723fc248960e
parentd4cbf516b1cdd2dfa7017e153d7591d6b93b8f62 [diff]
Format with black
line-length 88
26 files changed
tree: 99cac602382c2911eabc4d1798f9723fc248960e
  1. .github/
  2. docs/
  3. resdb_driver/
  4. service/
  5. third_party/
  6. .bazelrc
  7. .gitignore
  8. CNAME
  9. Dockerfile
  10. entrypoint.sh
  11. format.sh
  12. INSTALL.sh
  13. license
  14. NOTICE
  15. README.md
  16. requirements.txt
  17. test_driver.py
  18. test_driver_2.py
  19. test_update_metadata.py
  20. WORKSPACE
README.md

ResilientDB SDK

Check Python is up-to-date (3.9+)

$ python3 --version

If your Python version number is too low you may encounter type hinting issues when attempting to run the code. You can use a Python virtual environment, as shown below.

First-time set up

$ sh INSTALL.sh

$ python3.10 -m venv venv

$ source venv/bin/activate

$ pip install -r requirements.txt

The correct Python configuration is needed for transaction validation.

Running KV service

If your virtual environment is not already active:

$ source venv/bin/activate

Run the script to start 4 local nodes

$ sh service/tools/start_kv_service_sdk.sh

Running Crow service (HTTP endpoints)

$ bazel build service/http_server/crow_service_main

$ bazel-bin/service/http_server/crow_service_main service/tools/config/interface/client.config service/http_server/server_config.config

For a list of endpoints visit here

Testing

$ bazel-bin/service/kv_service/kv_service_tools service/tools/config/interface/service.config set test 1234

Running the driver

Examples of using the driver can be seen in test_driver

Replace the db_root_url with the address of the ResilientDB HTTP endpoints e.g. 127.0.0.1:18000

TODO

  • Setting up linting (using black) through github hooks
  • convert the sdk into a package (for pip install)
  • Potentially have a docker setup which fetched the Resdb image and runs it locally