update doc strings and type hints
3 files changed
tree: 8e15729f65bf8bff7c7053ca2b8e818284bd5acc
  1. docs/
  2. resdb_driver/
  3. .gitignore
  4. license
  5. README.md
  6. requirements.txt
  7. test_driver.py
  8. test_update_metadata.py
README.md

resdb_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

Installing dependencies

$ python3 -m venv venv

$ source venv/bin/activate

$ pip install -r requirements.txt

Running the driver

examples of using the driver can be seen in test_driver

replace the db_root_url with the url of resilient db e.g 120.0.0.1:8080

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