{"id":25077391,"url":"https://github.com/metricq/aiocouch","last_synced_at":"2025-10-29T04:32:40.581Z","repository":{"id":39587587,"uuid":"191375558","full_name":"metricq/aiocouch","owner":"metricq","description":"🛋 An asynchronous client library for CouchDB 2.x and 3.x","archived":false,"fork":false,"pushed_at":"2024-08-16T11:59:18.000Z","size":308,"stargazers_count":30,"open_issues_count":3,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-14T03:02:50.290Z","etag":null,"topics":["asyncio","couchdb","library","python3"],"latest_commit_sha":null,"homepage":"https://aiocouch.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/metricq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-11T13:18:29.000Z","updated_at":"2024-12-13T16:36:40.000Z","dependencies_parsed_at":"2025-02-14T03:03:01.657Z","dependency_job_id":null,"html_url":"https://github.com/metricq/aiocouch","commit_stats":{"total_commits":206,"total_committers":10,"mean_commits":20.6,"dds":"0.45145631067961167","last_synced_commit":"8f1a116576dcb6097ab5ec60a3b2bb02d91403ed"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metricq%2Faiocouch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metricq%2Faiocouch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metricq%2Faiocouch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metricq%2Faiocouch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metricq","download_url":"https://codeload.github.com/metricq/aiocouch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238772114,"owners_count":19527880,"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":["asyncio","couchdb","library","python3"],"created_at":"2025-02-07T02:24:57.956Z","updated_at":"2025-10-29T04:32:35.277Z","avatar_url":"https://github.com/metricq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![PyPI version](https://badge.fury.io/py/aiocouch.svg)](https://badge.fury.io/py/aiocouch)\n![Python package](https://github.com/metricq/aiocouch/workflows/Python%20package/badge.svg)\n[![codecov](https://codecov.io/gh/metricq/aiocouch/branch/master/graph/badge.svg)](https://codecov.io/gh/metricq/aiocouch)\n[![Documentation Status](https://readthedocs.org/projects/aiocouch/badge/?version=latest)](https://aiocouch.readthedocs.io/en/latest/?badge=latest)\n\n\n# aiocouch\nAn asynchronous client library for CouchDB 2.0 based on asyncio using aiohttp\n\n## Key features\n\n- All requests are asynchronus using aiohttp\n- Supports CouchDB 2.x and 3.x\n- Support for modern Python ≥ 3.7\n\n\n## Library installation\n\n```\n    pip install aiocouch\n```\n\n## Getting started\n\nThe following code retrieves and prints the list of `incredients` of the *apple_pie* `recipe`.\nThe `incredients` are stored as a list in the *apple_pie* `aiocouch.document.Document`,\nwhich is part of the `recipe` `aiocouch.database.Database`. We use the context manager\n`aiocouch.CouchDB` to create a new session.\n\n```python\n\n    from aiocouch import CouchDB\n\n    async with CouchDB(\n        \"http://localhost:5984\", user=\"admin\", password=\"admin\"\n    ) as couchdb:\n        db = await couchdb[\"recipes\"]\n        doc = await db[\"apple_pie\"]\n        print(doc[\"incredients\"])\n```\n\nWe can also create new recipes, for instance for some delicious cookies.\n\n```python\n\n        new_doc = await db.create(\n            \"cookies\", data={\"title\": \"Granny's cookies\", \"rating\": \"★★★★★\"}\n        )\n        await new_doc.save()\n```\n\nFor further details please refer to the documentation, which is available [here on readthedocs.org](https://aiocouch.readthedocs.io/).\n\n## Run examples\n\n- Setup the CouchDB URL and credentials using the environment variables\n- Install dependencies using `pip install --editable '.[examples]'`\n- run for instance `python examples/getting_started.py`\n\n\n## Run tests\n\n- Install dependencies using `pip install --editable '.[tests]'`\n- Setup the CouchDB URL and credentials using the environment variables (`COUCHDB_HOST`, `COUCHDB_USER`, `COUCHDB_PASS`)\n- run `pytest --cov=aiocouch`\n\n\n## Generate documentation\n\n- Install dependencies using `pip install '.[docs]'`\n- switch to the `docs` directory: `cd docs`\n- run `make html`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetricq%2Faiocouch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetricq%2Faiocouch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetricq%2Faiocouch/lists"}