py-orbit-db-http-client

A python client for the Orbitdb HTTP API

Status: Proof-of-concept

Install

pip install orbitdbapi

Clone, and then run:

git clone https://github.com/orbitdb/py-orbit-db-http-client.git
cd py-orbit-db-http-client
py setup.py

from orbitdbapi import OrbitDbAPI
client = OrbitDbAPI(base_url='http://localhost:3000')

You can then use the client object to list all the databases available on the API:

dbs = client.list_dbs()
print(dbs)

To open a specific database, you can use the db() method, providing the name of the database as an argument:

db = client.db('mydb')

Once you have a DB object, you can use it to perform CRUD operations on the database. For example, to add an entry to the database:

db.add({'key': 'value'})

To retrieve all the entries in the database:

entries = db.all()
print(entries)

To retrieve a specific entry by its key:

entry = db.get('key')
print(entry)

To update an entry:

db.update('key', {'key': 'new_value'})

To remove an entry:

db.remove('key')

check the Jupyter Notebook example for local testing : orbitdb_test.ipynb

This is a work-in-progress. Feel free to contribute by opening issues or pull requests.