kybra-simple-db 0.1.2

A lightweight key-value database written in Python, intended for use with Kybra on the Internet Computer (IC)

Kybra Simple DB

TODO:

fix logging!! test canister update persistance of db data and instantiation test update database with new/less attributes and new/less entities (migrations) why _id needs to be a str? change the logger to an actual Python standard logging... make it possible to select mixings more granually (timestamps / user)

review audit and test examples add coverage linting final cleaning readme remove printouts, TODO, etc. RELEASE!

A lightweight key-value database with entity relationships and audit logging capabilities, intended for small to medium-sized applications running on the Internet Computer using Kybra.

Quick Start

Basic Usage

Example 1

# Step 1: Import Kybra and define storage
from kybra import StableBTreeMap
db_storage  = StableBTreeMap[str, str](memory_id=..., max_key_size=..., max_value_size=...)

# Step 2: Import Kybra Simple DB and initialize database
from kybra_simple_db import *
Database(db_storage)

# Step 3: Run your application using the database

# TODO

Installation

On your Kybra project, copy the folder

TODO: insert directory tree

If not using Kybra, just:

pip install ...

Features

• Uses IC persistent storage (StableBTreeMap)when used on the Internet Computer, although it can be run outside IC using a custom storage object.
• No need for calling ".save()". Just use the variables seamlessly (TODO: explain better)
• Simple key-value storage with JSON serialization
• Entity-relationship management
• Audit logging of all operations
• Pluggable storage backends
• Type hints for better IDE support
• Zero dependencies
• Python 3.10.7 support
• Timestamp and ownership tracking via mixins
• System time management for testing and synchronization

Advance usage

Example 2

TODO

Running Tests

To run the test suite:

pip install -r requirements-dev.txt
python -m pytest -v
python -m pylint kybra_simple_db tests

Development

# Clone the repository
git clone https://github.com/smart-social-contracts/kybra_simple_db.git
cd kybra_simple_db

# Recommended steps
pip install pyenv virtualenv
pyenv local 3.10.7
python -m virtualenv venv
source venv/bin/activate

# Install development dependencies
pip install -r requirements-dev.txt

# Run tests
cd tests && ./run_test.sh

# Run linters
black .
isort .
flake8 .
mypy .

License

MIT