Metadata-Version: 2.1
Name: couchutils
Version: 0.5.0
Summary: A collection of CouchDB utils.
Home-page: https://github.com/rwanyoike/couchutils-python
License: MIT
Author: Raymond Wanyoike
Author-email: raymond.wanyoike@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Documentation, https://github.com/rwanyoike/couchutils-python/tree/main/docs
Project-URL: Repository, https://github.com/rwanyoike/couchutils-python
Description-Content-Type: text/markdown

# couchutils: Python CouchDB Utils

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/rwanyoike/couchutils-python/python-package.yml?branch=main)
](https://github.com/rwanyoike/couchutils-python/actions/workflows/python-package.yml?query=branch%3Amain)
[![GitHub License](https://img.shields.io/github/license/rwanyoike/couchutils-python)
](LICENSE.txt)
[![PyPI - Version](https://img.shields.io/pypi/v/couchutils)
](https://pypi.org/project/couchutils)

> A collection of CouchDB utils.

To use couchutils in a project:

```python
>>> from couchutils import <METHOD>
```

[Features](#features) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) | [License](#license) | [Related Projects](#related-projects)

## Features

couchutils officially supports Python 3.8+; CouchDB 1.7+.

## Installation

To install couchutils, simply run:

```shell
$ pip install -U couchutils
✨🛋✨
```

## Usage

For documentation, see [`./docs/README.md`](./docs/README.md).

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

This project is licensed under the [MIT License](./LICENSE).

## Related Projects

- [time2relax](https://github.com/rwanyoike/time2relax-python-driver) - A Python CouchDB driver.

