ResDB-ORM¶

ResDB-ORM is a Python module designed to simplify interactions with ResilientDB's key-value store database by providing an Object-Relational Mapping (ORM) interface. This library allows developers to use basic CRUD functionalities with ease.

Prerequisites¶

Before using this repository, ensure that the following services are running:

kv_server: This is the key-value store server that forms the backend for ResilientDB. Follow the instructions in the ResilientDB repository to set it up and start it.
ResilientDB-GraphQL: This provides a GraphQL interface to interact with ResilientDB. Follow the instructions in the ResilientDB-GraphQL repository to set it up and start it.

Setting up Prerequisites¶

You can use the provided INSTALL.sh script to automatically install and set up both the kv_server and ResilientDB-GraphQL services. The script will clone the necessary repositories, build the services, and start them.

To use the INSTALL.sh script:

git clone https://github.com/ResilientEcosystem/ResDB-ORM.git
cd ResDB-ORM
./INSTALL.sh

Installation¶

ResDB-ORM is also available on PyPI and can be installed using pip:

pip install resdb-orm

Once the above services are running, follow the steps below to set up and use ResDB-ORM.

1. Clone this Repository¶

git clone https://github.com/ResilientEcosystem/ResDB-ORM.git
cd ResDB-ORM

Note: The script may require sudo privileges to install dependencies and set up services.

2. Create and Activate a Virtual Environment¶

Set up a virtual environment to manage dependencies:

python3 -m venv venv
source venv/bin/activate

3. Install Dependencies¶

Ensure that you have all necessary dependencies installed:

pip install -r requirements.txt

4. Configure `config.yaml`¶

Update the config.yaml file to point to the correct Crow endpoint. After running ResilientDB-GraphQL, you should see output similar to the following:

(2024-08-17 00:03:53) [INFO    ] Crow/1.0 server is running at <CROW_ENDPOINT> using 16 threads
(2024-08-17 00:03:53) [INFO    ] Call `app.loglevel(crow::LogLevel::Warning)` to hide Info level logs.

Replace <CROW_ENDPOINT> in the config.yaml file with the actual endpoint URL from the above output.

5. Verify Installation¶

Run the provided test.py script to verify that everything is set up correctly:

python test.py

This script will perform basic operations to ensure that the connection to the ResilientDB instance is functional.

6. Import the Module in Your Own Code¶

You can now import and use the ResDBORM module in your own projects:

from resdb_orm.orm import ResDBORM

Initialize the ORM¶

orm = ResDBORM()

# Example usage: Create a new record
data = {"key": "value"}
record_id = orm.create(data)
print(f"Record created with ID: {record_id}")`

Contributing¶

We welcome contributions to this project! Please feel free to submit pull requests, report issues, or suggest new features.

License¶

This project is licensed under the Apache License 2.0.