Cryptography primitives for Hypercore
Go to file
Luke Murphy 2c50616ab8
Add example and fix links
2019-10-06 16:19:11 +02:00
changelog Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
documentation Once again fight RTD to install the package 2019-10-05 22:14:00 +02:00
hypercore_crypto Clean up typing 2019-10-05 21:22:01 +02:00
test Finalise the rest of the module 2019-10-05 20:28:55 +02:00
.gitignore Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
.readthedocs.yml Once again fight RTD to install the package 2019-10-05 22:14:00 +02:00
.travis.yml Add libsodium in the CI env 2019-10-05 22:00:00 +02:00
CHANGELOG.rst Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
CODE_OF_CONDUCT.rst Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
CONTRIBUTING.rst Simplify contrib docs 2019-10-06 16:18:50 +02:00
LICENSE Use right license to match original 2019-10-06 16:18:58 +02:00
MANIFEST.in Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
README.rst Add example and fix links 2019-10-06 16:19:11 +02:00
mypy.ini Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
pyproject.toml Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
setup.cfg Polishing before the next release 2019-10-05 21:03:06 +02:00
setup.py Roll out the new boilerplate 2019-10-04 23:20:02 +02:00
tox.ini Inline all the tox definitions 2019-10-06 15:14:09 +02:00

README.rst

.. _header:

****************
hypercore-crypto
****************

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

.. image:: https://badge.fury.io/py/hypercore-crypto.svg
   :target: https://badge.fury.io/py/hypercore-crypto
   :alt: PyPI package

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

.. image:: https://readthedocs.org/projects/hypercore-crypto/badge/?version=latest
   :target: https://hypercore-crypto.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:

Cryptography primitives for Hypercore
-------------------------------------

Cryptography primitives for `Hypercore`_ (WIP).

.. _Hypercore: https://hypercore.readthedocs.io

.. _example:

Example
*******

.. code-block:: python

    from hypercore_crypto import key_pair, sign, verify

    public_key, secret_key = key_pair()
    signature = sign(b'hello world', secret_key)
    verify(message, signature, public_key)

.. _documentation:

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

* `hypercore-crypto.readthedocs.io`_

.. _hypercore-crypto.readthedocs.io: https://hypercore-crypto.readthedocs.io/

Mirroring
*********

* `hack.decentral1.se/datpy/hypercore-crypto`_
* `github.com/datpy/hypercore-crypto`_

.. _hack.decentral1.se/datpy/hypercore-crypto: https://hack.decentral1.se/datpy/hypercore-crypto
.. _github.com/datpy/hypercore-crypto: https://github.com/datpy/hypercore-crypto