hyperpy
/
merkle-tree-stream
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A stream that generates a merkle tree based on the incoming data
14 Commits 1 Branch 4 Tags 128 KiB
Python 100%
Go to file
Luke Murphy 065eb1fdac
Focus on Iterator protocol - tests passing! 
Too much naming copy/pasta will probably confuse Python programmers when
we have generator/iterators and I suppose we have streams but that is
just so generic that it won't help.

So, better make it explicit that this is an iterator.

It also seems to the fit the usage of the other implementors.
 		2019-08-01 17:21:28 +02:00
changelog Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
documentation Fix documentation to render correctly 2019-08-01 13:15:07 +02:00
merkle_tree_stream Focus on Iterator protocol - tests passing! 2019-08-01 17:21:28 +02:00
test Focus on Iterator protocol - tests passing! 2019-08-01 17:21:28 +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
CHANGELOG.rst Initialise the new module boilerplate 2019-07-08 11:40:40 +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 naming hyphenation from boilerplate 2019-07-08 13:04:00 +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 Fix naming hyphenation from boilerplate 2019-07-08 13:04:00 +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://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 merkle tree is 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

.. _documentation:

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

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

Code of Conduct
***************

By participating in the merkle-tree-stream community, you agree on the
following code of conduct. Please see `CODE_OF_CONDUCT`_ for the full text.

.. _CODE_OF_CONDUCT: ./CODE_OF_CONDUCT