Metadata-Version: 2.4
Name: human-readable-id
Version: 0.0.1
Summary: Human Readable ID (hrid) generates short, human-readable, collision-aware, friendly IDs that are ideal for experiments, jobs, and filenames.
Author-email: Karol Gotkowski <KarolGotkowski@gmx.de>
License: MIT
Project-URL: Homepage, https://github.com/Karol-G/human-readable-id
Project-URL: Source, https://github.com/Karol-G/human-readable-id
Project-URL: Issues, https://github.com/Karol-G/human-readable-id/issues
Keywords: copier,template,python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: twine>=4.0; extra == "dev"
Requires-Dist: setuptools_scm[toml]>=8.0; extra == "dev"
Dynamic: license-file

Human Readable ID
=================

![PyPI](https://img.shields.io/pypi/v/human-readable-id?logo=pypi&color=brightgreen)
![Python Version](https://img.shields.io/pypi/pyversions/human-readable-id?logo=python)
![Tests](https://img.shields.io/github/actions/workflow/status/Karol-G/human-readable-id/workflow.yml?branch=main&logo=github)
![Copier Template](https://img.shields.io/badge/copier-template-blue?logo=jinja)
![License](https://img.shields.io/github/license/Karol-G/human-readable-id)

Human Readable ID (hrid) generates short, human-readable, collision-aware, friendly IDs that are ideal for experiments, jobs, and filenames.

## Installation

You can install human-readable-id via [pip](https://pypi.org/project/human-readable-id/):
```bash
pip install human-readable-id
```

## Usage

```python
from human_readable_id import __version__

print(__version__)
```

## Contributing

Contributions are welcome! Please open a pull request with clear changes and add tests when appropriate.

## Issues

Found a bug or have a request? Open an issue at https://github.com/Karol-G/human-readable-id/issues.

## License

Distributed under the MIT license. See `LICENSE` for details.
