Google Git
Sign in
apache / incubator-resilientdb-python-sdk / ecd419c699d196215a447c0391aabed85191d37e
commitecd419c699d196215a447c0391aabed85191d37e[log] [tgz]
authorGopal Nambiar <gopalnambiar2@gmail.com>Thu Nov 16 15:34:54 2023 -0800
committerGitHub <noreply@github.com>Thu Nov 16 15:34:54 2023 -0800
tree6ce9d367f73f8fd83d580afcde44a62a0e93e448
parent96a07dc49702370bd099e99a4b639a528e8a826b [diff]
parent7c788fbb1ff0cede54bd1e3847fa53202ab3cc6f [diff]
Merge pull request #13 from resilientdb/logo_latest

Updated loqo quality
tree: 6ce9d367f73f8fd83d580afcde44a62a0e93e448
  1. .github/
  2. docs/
  3. resdb_driver/
  4. service/
  5. third_party/
  6. .bazelrc
  7. .gitignore
  8. CNAME
  9. Dockerfile
  10. entrypoint.sh
  11. INSTALL.sh
  12. license
  13. README.md
  14. requirements.txt
  15. test_driver.py
  16. test_driver_2.py
  17. test_update_metadata.py
  18. 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/service.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