Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orbitdb/py-orbit-db-http-client
A python client for the Orbitdb HTTP API
https://github.com/orbitdb/py-orbit-db-http-client
http orbit orbitdb python
Last synced: 3 months ago
JSON representation
A python client for the Orbitdb HTTP API
- Host: GitHub
- URL: https://github.com/orbitdb/py-orbit-db-http-client
- Owner: orbitdb
- License: mit
- Created: 2019-03-17T05:58:48.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-23T10:56:22.000Z (about 2 years ago)
- Last Synced: 2024-04-23T14:42:03.409Z (10 months ago)
- Topics: http, orbit, orbitdb, python
- Language: Python
- Size: 34.2 KB
- Stars: 30
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-orbit-db-http-client
[](https://gitter.im/orbitdb/Lobby) [](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io)
> A python client for the Orbitdb HTTP API
Status: Proof-of-concept
------------------------------
## Install
### Install from `pip`
```sh
pip install orbitdbapi
```
### Install using source
Clone, and then run:
```sh
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](./example/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](LICENSE)