# Humus.py
## (A python client for) a composting database.
Simple python client for [Humus](https://github.com/timcowlishaw/humus), the forgetful database.
### Installation:
```bash
pip install humus.py # Not pip install humus, that's someone else's project that ironically does the complete opposite
```
### Usage:
First, make sure the [Humus server](https://github.com/timcowlishaw/humus) is running somewhere you can access it.
Then you can create a client object:
```python
import humus
# Create a client.
# Looks for HUMUS_PROTOCOL, HUMUS_HOST and HUMUS_PORT environment variables,
# or by default connects to humus on http://localhost:3030
client = humus.Client()
# Otherwise you can provide protocol, host and port as arguments:
client = humus.Client(host="somehost", port=1234, protocol="https")
```
Once you have your client, you can start storing and retrieving objects:
```python
# Put (any json-serializable) dict at a path:
client.insert("path/to/the_object", { "hello": "world"})
# Get objects at a path:
client.get("path/to/the_object")
# => [{ "hello": "world"}]
```
Further information on the humus, its data model, and our innovative and forward-thinking **strong guarantee of transience™** can be found in [the main humus repository](https://github.com/timcowlishaw/humus).
Raw data
{
"_id": null,
"home_page": "https://github.com/timcowlishaw/humus.py",
"name": "humus.py",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "database, client, permacomputing, compost, decay, experimental",
"author": "Tim Cowlishaw",
"author_email": "tim@timcowlishaw.co.uk",
"download_url": "https://files.pythonhosted.org/packages/ac/93/727cd5bb415230c5743341465c4e132decdbda5e766a191e54f7293aaf1d/humus_py-0.1.0.tar.gz",
"platform": null,
"description": "# Humus.py\n## (A python client for) a composting database.\n\nSimple python client for [Humus](https://github.com/timcowlishaw/humus), the forgetful database.\n\n### Installation:\n\n```bash\npip install humus.py # Not pip install humus, that's someone else's project that ironically does the complete opposite\n```\n\n### Usage:\n\nFirst, make sure the [Humus server](https://github.com/timcowlishaw/humus) is running somewhere you can access it.\n\nThen you can create a client object:\n\n\n```python\nimport humus\n\n# Create a client.\n# Looks for HUMUS_PROTOCOL, HUMUS_HOST and HUMUS_PORT environment variables,\n# or by default connects to humus on http://localhost:3030\n\nclient = humus.Client()\n\n# Otherwise you can provide protocol, host and port as arguments:\nclient = humus.Client(host=\"somehost\", port=1234, protocol=\"https\")\n```\n\nOnce you have your client, you can start storing and retrieving objects:\n\n```python\n# Put (any json-serializable) dict at a path:\nclient.insert(\"path/to/the_object\", { \"hello\": \"world\"})\n\n# Get objects at a path:\nclient.get(\"path/to/the_object\")\n# => [{ \"hello\": \"world\"}]\n```\n\nFurther information on the humus, its data model, and our innovative and forward-thinking **strong guarantee of transience\u2122** can be found in [the main humus repository](https://github.com/timcowlishaw/humus).\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A client for the humus composting database",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/timcowlishaw/humus.py",
"Repository": "https://github.com/timcowlishaw/humus.py"
},
"split_keywords": [
"database",
" client",
" permacomputing",
" compost",
" decay",
" experimental"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8273cc879af3081e08915c937b7710f2b254c0bdc5726803575a2fb79b1dc2b",
"md5": "012c5afd29daef0a0df76af985a5348e",
"sha256": "2faadc6211dfc4111425327654efd2b36bcf082f1b57d46aff48f5e0b36d5642"
},
"downloads": -1,
"filename": "humus_py-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "012c5afd29daef0a0df76af985a5348e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 14154,
"upload_time": "2024-10-09T15:35:18",
"upload_time_iso_8601": "2024-10-09T15:35:18.295068Z",
"url": "https://files.pythonhosted.org/packages/b8/27/3cc879af3081e08915c937b7710f2b254c0bdc5726803575a2fb79b1dc2b/humus_py-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac93727cd5bb415230c5743341465c4e132decdbda5e766a191e54f7293aaf1d",
"md5": "6d1b704a4e16020b507fd844a265b3e3",
"sha256": "0affbf80ad53bdbf1131c5424cf68aa6e1f3f58d9b5014c50f4164e9fc25504c"
},
"downloads": -1,
"filename": "humus_py-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6d1b704a4e16020b507fd844a265b3e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 13805,
"upload_time": "2024-10-09T15:35:20",
"upload_time_iso_8601": "2024-10-09T15:35:20.483354Z",
"url": "https://files.pythonhosted.org/packages/ac/93/727cd5bb415230c5743341465c4e132decdbda5e766a191e54f7293aaf1d/humus_py-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 15:35:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timcowlishaw",
"github_project": "humus.py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "humus.py"
}
JSON
