Metadata-Version: 2.1
Name: merkly
Version: 0.4.1
Summary: 🌳 The simple and easy implementation of Merkle Tree
Home-page: https://github.com/olivmath/merkly.git
License: MIT
Keywords: merkle-tree,merkle-proof,merkle-root,keccak256,blockchain
Author: Lucas Oliveira
Author-email: olivmath@protonmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: pysha3 (>=1.0.2,<2.0.0)
Project-URL: Documentation, https://pypi.org/project/merkly/
Project-URL: Repository, https://github.com/olivmath/merkly.git
Description-Content-Type: text/markdown

# 🌳 Merkly

The **simple and easy** implementation of **Python Merkle Tree**

---

[![Test](https://github.com/olivmath/merkly/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/olivmath/merkly/actions/workflows/test.yml)
![GitHub last commit](https://img.shields.io/github/last-commit/olivmath/merkly)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/olivmath/merkly)

[![PyPI](https://img.shields.io/pypi/v/merkly)](https://pypi.org/project/merkly/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/merkly)](https://pypi.org/project/merkly/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/merkly)](https://pypi.org/project/merkly/)
![PyPI - License](https://img.shields.io/pypi/l/merkly)

## CREDITS

[![GitHub Contributors Image](https://contrib.rocks/image?repo=olivmath/merkly)](https://github.com/olivmath/merkly/graphs/contributors)

## HOW TO INSTALL

```
poetry add merkly
```

```
pip install merkly
```

## HOW IT WORKS

This library provides a clean and easy to use implementation of the Merkle Tree with the following features:

- [x] Create Leaf
- [x] Create Root
- [ ] Create Proof
- [ ] Validate Leafs

## CONTRIBUTING

- Before read a code of conduct: **[CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)**
- Follow the guide of development: **[CONTRIBUTING](CONTRIBUTING.md)**

## LICENSE

[MIT](LICENSE)

