Metadata-Version: 2.4
Name: pypricklybird
Version: 1.0.0
Summary: Python library to encode and decode pricklybird.
Project-URL: Documentation, https://github.com/ndornseif/pypricklybird#readme
Project-URL: Issues, https://github.com/ndornseif/pypricklybird/issues
Project-URL: Source, https://github.com/ndornseif/pypricklybird
Author-email: ndornseif <5382403+ndornseif@users.noreply.github.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# pypricklybird

[![PyPI - Version](https://img.shields.io/pypi/v/pypricklybird.svg)](https://pypi.org/project/pypricklybird)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypricklybird.svg)](https://pypi.org/project/pypricklybird)

-----

## Overview 
This is a python implementation of the [pricklybird](https://github.com/ndornseif/pricklybird) format.

## Usage
```python
>>> from pypricklybird import convert_to_pricklybird, convert_from_pricklybird
>>> data = bytearray.fromhex("4243")
>>> code = convert_to_pricklybird(data);
>>> code
'flea-flux-full'
>>> convert_from_pricklybird(code).hex()
'4243'
```

## Documentation
See the [docs/html](https://github.com/ndornseif/pypricklybird/tree/main/docs/html) folder of the github reposity for documentation.

## Installation

```console
pip install pypricklybird
```

## License

`pypricklybird` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
