{"id":18908826,"url":"https://github.com/orbitdb-archive/py-orbit-db-http-client","last_synced_at":"2025-04-15T05:32:10.449Z","repository":{"id":53088007,"uuid":"176062356","full_name":"orbitdb-archive/py-orbit-db-http-client","owner":"orbitdb-archive","description":"A python client for the Orbitdb HTTP API","archived":true,"fork":false,"pushed_at":"2023-01-23T10:56:22.000Z","size":35,"stargazers_count":36,"open_issues_count":1,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T21:08:40.252Z","etag":null,"topics":["http","orbit","orbitdb","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orbitdb-archive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-17T05:58:48.000Z","updated_at":"2025-03-25T09:22:40.000Z","dependencies_parsed_at":"2023-02-12T22:20:31.151Z","dependency_job_id":null,"html_url":"https://github.com/orbitdb-archive/py-orbit-db-http-client","commit_stats":null,"previous_names":["orbitdb-archive/py-orbit-db-http-client","orbitdb/py-orbit-db-http-client"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb-archive%2Fpy-orbit-db-http-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb-archive%2Fpy-orbit-db-http-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb-archive%2Fpy-orbit-db-http-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb-archive%2Fpy-orbit-db-http-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orbitdb-archive","download_url":"https://codeload.github.com/orbitdb-archive/py-orbit-db-http-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249015511,"owners_count":21198823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["http","orbit","orbitdb","python"],"created_at":"2024-11-08T09:28:50.137Z","updated_at":"2025-04-15T05:32:10.183Z","avatar_url":"https://github.com/orbitdb-archive.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# py-orbit-db-http-client\n\n[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) [![Matrix](https://img.shields.io/badge/matrix-%23orbitdb%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io)\n\n\u003e A python client for the Orbitdb HTTP API\n\nStatus: Proof-of-concept\n\n------------------------------\n## Install\n\n### Install from `pip`\n```sh\npip install orbitdbapi\n```\n\n### Install using source\nClone, and then run:\n```sh\ngit clone https://github.com/orbitdb/py-orbit-db-http-client.git\ncd py-orbit-db-http-client\npy setup.py\n```\n-----------------------------\n## Usage\n\u003e \n```\nfrom orbitdbapi import OrbitDbAPI\nclient = OrbitDbAPI(base_url='http://localhost:3000')\n```\nYou can then use the client object to list all the databases available on the API:\n```\ndbs = client.list_dbs()\nprint(dbs)\n```\nTo open a specific database, you can use the db() method, providing the name of the database as an argument:\n```\ndb = client.db('mydb')\n```\nOnce 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:\n```\ndb.add({'key': 'value'})\n```\nTo retrieve all the entries in the database:\n```\nentries = db.all()\nprint(entries)\n```\nTo retrieve a specific entry by its key:\n```\nentry = db.get('key')\nprint(entry)\n```\nTo update an entry:\n```\ndb.update('key', {'key': 'new_value'})\n```\nTo remove an entry:\n```\ndb.remove('key')\n```\n\ncheck the Jupyter Notebook example for local testing : [orbitdb_test.ipynb](./example/orbitdb_test.ipynb)\n\n-----------------------\n\n## Contributing\n\nThis is a work-in-progress. Feel free to contribute by opening issues or pull requests.\n\n--------------------------\n\n## License\n\n[MIT Copyright (c) 2019 phillmac](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbitdb-archive%2Fpy-orbit-db-http-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forbitdb-archive%2Fpy-orbit-db-http-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbitdb-archive%2Fpy-orbit-db-http-client/lists"}