Metadata-Version: 2.1
Name: duniterpy
Version: 0.43.6
Summary: A python implementation of [duniter](https://github.com/duniter/duniter) API
Home-page: https://github.com/duniter/duniter-python-api
Author: inso, canercanda, s_b
Author-email: insomniak.fr@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: French
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Communications
Requires-Dist: aiohttp
Requires-Dist: pylibscrypt
Requires-Dist: libnacl
Requires-Dist: base58
Requires-Dist: jsonschema
Requires-Dist: pypeg2

Duniter Python API
==================

.. image:: https://coveralls.io/repos/duniter/duniter-python-api/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/duniter/duniter-python-api?branch=master

Python implementation of `Duniter <https://git.duniter.org/nodes/typescript/duniter>`_ BMA API

Features
--------

* Supports Duniter's `Basic Merkle API <https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/HTTP_API.md>`_ and `protocol <https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/Protocol.md>`_
* Asynchronous
* Duniter signing key

Requirements
------------

* Python >= 3.5
* `aiohttp >= 0.19 <https://pypi.python.org/pypi/aiohttp>`_
* `pylibscrypt <https://pypi.python.org/pypi/pylibscrypt>`_
* `libnacl <https://pypi.python.org/pypi/libnacl>`_
* `base58 <https://pypi.python.org/pypi/base58>`_

Installation
------------

You can install duniter-python-api and all its dependencies via the following pip install:

:code:`pip3 install duniterpy`

Please take a look at the document `HTTP API <https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/HTTP_API.md>`_ to learn about the API.

Development
-----------

* Create a python environment with pyenv
* Add PYTHONPATH env var to your shell containing the path to this repository
* Take a look at examples
* Run examples from parent folder :code:`python examples/request_data.py`

Documentation
-------------

* `HTML Documentation <https://git.duniter.org/clients/python/duniterpy/tree/master/docs/_build/html>`_
* `Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_

Packaging and deploy
--------------------

Pypi
++++

*The README file must be in RestructuredText format (README.rst) for the long description field of the package.*

In the development pyenv environment, install the following tools::

    pip install --upgrade pip setuptools wheel

    pip install twine

Change the version number (semantic version number)::

    ./release.sh 0.42.3

Build the Pypi package in the ``dist`` folder::

    python setup.py sdist bdist_wheel

Deploy the package on the Pypi repository::

    twine upload dist/*



