| Name | couchbeans JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | A CouchDB library for python, focused on network resilience. |
| upload_time | 2025-02-10 17:03:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.4 |
| license | LGPL-3.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CouchBeans
*Have you ever held up a broken couch with a tin of beans?* CouchBeans is a [CouchDB](https://couchdb.apache.org/) library for python, aiming to provide as much resilience as possible for dodgy network environments. It's designed to be quick and easy to use, with as much complexity hidden from the user as possible.
A quick example:
```
>>> from couchbeans import CouchClient
>>> db = CouchClient("http://root:couchbeans@localhost:5984/")
>>> db.create_db("main")
True
>>> db.put_document("main", "bean", {"type": "baked"})
{'ok': True, 'id': 'bean', 'rev': '1-975cf46dd62455d25b4743874062ebfe'}
>>> db.get_document("main", "bean")
{'_id': 'bean', '_rev': '1-975cf46dd62455d25b4743874062ebfe', 'type': 'baked'}
```
Have a look at the [test script](https://github.com/owoalex/couchbeans/blob/main/test/example.py) for more examples of how to use CouchBeans. The API quick reference can be found in [docs/api-ref.md](https://github.com/owoalex/couchbeans/blob/main/docs/api-ref.md).
## Installation
CouchBeans is installable via PIP:
```pip install couchbeans```
## Features
The main advantage of CouchBeans over other CouchDB libraries is its default handling of failed requests. CouchBeans will try a user-configurable number of times to execute a request to help with spotty network connections.
CouchBeans provides utility functions for modifying documents, including a patch operation. It also hides handling of the _rev parameter, making it easy to forget about the underlying network connections.
## Dependencies
- requests
Raw data
{
"_id": null,
"home_page": null,
"name": "couchbeans",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Alex Baldwin <contact@alexbaldwin.dev>",
"download_url": "https://files.pythonhosted.org/packages/8f/6c/c63bd2d2cf74ecf85f82e4edcf0b8cd4b1325b241058af68acd845b25c4a/couchbeans-0.0.4.tar.gz",
"platform": null,
"description": "# CouchBeans\n*Have you ever held up a broken couch with a tin of beans?* CouchBeans is a [CouchDB](https://couchdb.apache.org/) library for python, aiming to provide as much resilience as possible for dodgy network environments. It's designed to be quick and easy to use, with as much complexity hidden from the user as possible.\n\nA quick example:\n```\n>>> from couchbeans import CouchClient\n>>> db = CouchClient(\"http://root:couchbeans@localhost:5984/\")\n>>> db.create_db(\"main\")\nTrue\n>>> db.put_document(\"main\", \"bean\", {\"type\": \"baked\"})\n{'ok': True, 'id': 'bean', 'rev': '1-975cf46dd62455d25b4743874062ebfe'}\n>>> db.get_document(\"main\", \"bean\")\n{'_id': 'bean', '_rev': '1-975cf46dd62455d25b4743874062ebfe', 'type': 'baked'}\n```\n\nHave a look at the [test script](https://github.com/owoalex/couchbeans/blob/main/test/example.py) for more examples of how to use CouchBeans. The API quick reference can be found in [docs/api-ref.md](https://github.com/owoalex/couchbeans/blob/main/docs/api-ref.md).\n\n## Installation\nCouchBeans is installable via PIP:\n```pip install couchbeans```\n\n## Features\nThe main advantage of CouchBeans over other CouchDB libraries is its default handling of failed requests. CouchBeans will try a user-configurable number of times to execute a request to help with spotty network connections.\n\nCouchBeans provides utility functions for modifying documents, including a patch operation. It also hides handling of the _rev parameter, making it easy to forget about the underlying network connections.\n\n## Dependencies\n\n- requests\n",
"bugtrack_url": null,
"license": "LGPL-3.0",
"summary": "A CouchDB library for python, focused on network resilience.",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/owoalex/couchbeans",
"Issues": "https://github.com/owoalex/couchbeans/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e3101be7fbb538985434e6c2f16822cce00da4cfc90b7c25d7b883acb0128b33",
"md5": "dfa518dad7a191ad544d03b997aab23f",
"sha256": "850f86688ca34fe5bed738cc933d4d05a529b014bacb39962b20df259b691556"
},
"downloads": -1,
"filename": "couchbeans-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfa518dad7a191ad544d03b997aab23f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 7074,
"upload_time": "2025-02-10T17:03:12",
"upload_time_iso_8601": "2025-02-10T17:03:12.822452Z",
"url": "https://files.pythonhosted.org/packages/e3/10/1be7fbb538985434e6c2f16822cce00da4cfc90b7c25d7b883acb0128b33/couchbeans-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8f6cc63bd2d2cf74ecf85f82e4edcf0b8cd4b1325b241058af68acd845b25c4a",
"md5": "47be30367de323fcc0417cdd0b20d6ee",
"sha256": "c088c3ca5c562ff17313edb3ee2ffefc8e8561468e62d64401ba5cdc4e384019"
},
"downloads": -1,
"filename": "couchbeans-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "47be30367de323fcc0417cdd0b20d6ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 11581,
"upload_time": "2025-02-10T17:03:14",
"upload_time_iso_8601": "2025-02-10T17:03:14.746852Z",
"url": "https://files.pythonhosted.org/packages/8f/6c/c63bd2d2cf74ecf85f82e4edcf0b8cd4b1325b241058af68acd845b25c4a/couchbeans-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-10 17:03:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "owoalex",
"github_project": "couchbeans",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "couchbeans"
}
