Code Monkey home page Code Monkey logo

py-orbit-db-http-client's Introduction

py-orbit-db-http-client

Gitter Matrix

A python client for the Orbitdb HTTP API

Status: Proof-of-concept


Install

Install from pip

pip install orbitdbapi

Install using source

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

Usage

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


Contributing

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


License

MIT Copyright (c) 2019 phillmac

py-orbit-db-http-client's People

Contributors

hemangjoshi37a avatar phillmac avatar richardlitt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

py-orbit-db-http-client's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.