A stream that generates a merkle tree based on the incoming data
Go to file
Luke Murphy 227feb3967
Fix link to module
2019-08-07 08:36:21 +02:00
changelog Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
documentation Fix link to module 2019-08-07 08:36:21 +02:00
merkle_tree_stream Finalise on naming and module imports 2019-08-07 07:58:26 +02:00
test Finalise on naming and module imports 2019-08-07 07:58:26 +02:00
.gitignore Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
.readthedocs.yml Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
.travis.yml Enable Travis 2019-08-04 00:49:57 +02:00
CHANGELOG.rst Mark change log entry for first alpha release 2019-08-07 07:58:58 +02:00
CODE_OF_CONDUCT.rst Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
CONTRIBUTING.rst Fix naming hyphenation from boilerplate 2019-07-08 13:04:00 +02:00
FUNDING.yml Add a Github funding file 2019-07-08 12:00:45 +02:00
LICENSE Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
MANIFEST.in Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
README.rst Fix link 2019-08-07 08:08:55 +02:00
mypy.ini Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
pyproject.toml Fix naming hyphenation from boilerplate 2019-07-08 13:04:00 +02:00
setup.cfg Another pass: rough shape of tree and tests 2019-08-01 13:06:32 +02:00
setup.py Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
tox.ini Use the correct extras for Tox 2019-08-01 17:25:08 +02:00

README.rst

.. _header:

******************
merkle-tree-stream
******************

.. image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
   :target: LICENSE
   :alt: Repository license

.. image:: https://badge.fury.io/py/merkle-tree-stream.svg
   :target: https://badge.fury.io/py/merkle-tree-stream
   :alt: PyPI package

.. image:: https://travis-ci.com/datpy/merkle-tree-stream.svg?branch=master
   :target: https://travis-ci.com/datpy/merkle-tree-stream
   :alt: Travis CI result

.. image:: https://readthedocs.org/projects/merkle-tree-stream/badge/?version=latest
   :target: https://merkle-tree-stream.readthedocs.io/en/latest/
   :alt: Documentation status

.. image:: https://img.shields.io/badge/support-maintainers-brightgreen.svg
   :target: https://decentral1.se
   :alt: Support badge

.. _introduction:

A stream that generates a merkle tree based on the incoming data
----------------------------------------------------------------

From `The Dat Protocol`_: 

.. _The Dat Protocol: https://datprotocol.github.io/book/ch01-01-flat-tree.html

    A hash tree or merkle tree is a tree in which every leaf node is labelled
    with the hash of a data block and every non-leaf node is labelled with the
    cryptographic hash of the labels of its child nodes. Merkle trees in Dat
    are specialized `flat trees`_ that contain the content of the archives.

    .. _Flat Trees: https://flat-tree.readthedocs.io/en/latest/

See the following for more:

  * The Dat Protocol: `Merkle Tree`_
  * The Dat Protocol: `Merkle Tree Stream`_

.. _Merkle Tree: https://datprotocol.github.io/book/ch01-02-merkle-tree.html
.. _Merkle Tree Stream: https://datprotocol.github.io/book/ch02-02-merkle-tree-stream.html

A note on naming
================

For the purposes of uniformity and easy of discovery alongside the reference
implementation, we use the same module name as `merkle-tree-stream`_. This may
cause confusion since it is not clear what exactly is referred to when using
the term "stream" in the context of Python. To be clear, this module provides a
`Python iterator`_ which appears to match the implementation and meaning of the
reference implementation.

.. _merkle-tree-stream: https://github.com/mafintosh/merkle-tree-stream
.. _Python iterator: https://docs.python.org/3/c-api/iter.html

.. _documentation:

Documentation
*************

* https://merkle-tree-stream.readthedocs.io/

Mirroring
*********

* https://hack.decentral1.se/datpy/merkle-tree-stream (primary)
* https://github.com/datpy/merkle-tree-stream