Metadata-Version: 2.4
Name: chaos-utils
Version: 0.5.0
Summary: Collection of handy utils written in Python 3
Project-URL: Homepage, https://github.com/ak1ra-lab/chaos-utils
Project-URL: Changelog, https://github.com/ak1ra-lab/chaos-utils/blob/master/CHANGELOG.md
Project-URL: Repository, https://github.com/ak1ra-lab/chaos-utils
Project-URL: Documentation, https://ak1ra-lab.github.io/chaos-utils/
Author-email: ak1ra <git@ak1ra.xyz>
License-Expression: MIT
License-File: LICENSE
Keywords: utils
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: argcomplete>=3.7.0
Requires-Dist: chardet>=5.2.0
Requires-Dist: httpx2>=2.3.0
Requires-Dist: pathspec>=0.12.1
Requires-Dist: pydantic>=2.0
Requires-Dist: pyzstd>=0.17.0
Description-Content-Type: text/markdown

# chaos-utils

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ak1ra-lab/chaos-utils/.github%2Fworkflows%2Fpublish-to-pypi.yaml)](https://github.com/ak1ra-lab/chaos-utils/actions/workflows/publish-to-pypi.yaml)
[![PyPI - Version](https://img.shields.io/pypi/v/chaos-utils)](https://pypi.org/project/chaos-utils/)
[![PyPI - Version](https://img.shields.io/pypi/v/chaos-utils?label=test-pypi&pypiBaseUrl=https%3A%2F%2Ftest.pypi.org)](https://test.pypi.org/project/chaos-utils/)
[![Docs](https://img.shields.io/badge/docs-online-0a7ea4)](https://ak1ra-lab.github.io/chaos-utils/)

Collection of handy utils written in Python 3

## Installation

```shell
pip install chaos-utils
```

## Modules

- **`dict_utils`** — recursive dictionary merging
- **`text_utils`** — text encoding detection, file I/O, JSON, Base64
- **`gitignore`** — `.gitignore`-aware filesystem traversal
- **`logging`** — structured logging with `JsonFormatter`
- **`tarfile`** — Zstd-compressed tar archive support
- **`notify`** — IM notifications via DingTalk, Feishu, Telegram, WeChat Work

See the [documentation](https://ak1ra-lab.github.io/chaos-utils/) for full API reference.

## Development

```shell
just lint
just typecheck
just test
just docs-build
```

## Documentation

The published documentation site lives at <https://ak1ra-lab.github.io/chaos-utils/>.
