Duniter Python API

Python implementation of Duniter BMA API

This is the most complete python library to communicate with Duniter nodes endpoints.

This library is used by Sakia, the rich client to manage your Duniter's wallets.

Features

• Support Duniter's Basic Merkle API and protocol
• Asynchronous/synchronous without threads
• Support HTTP, HTTPS and Web Socket transport for BMA API
• Support Elasticsearch Duniter4j API
• Duniter signing key
• Sign/verify and encrypt/decrypt messages with the Duniter credentials

Requirements

• Python >= 3.5.2
• aiohttp >= 0.19
• pylibscrypt
• libnacl
• base58
• attr

Installation

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

pip3 install duniterpy

Please take a look at the document HTTP API to learn about the API.

Development

• Create a python virtual environment with pyenv

  curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash`

• Install dependencies:

  pip install -r requirements.txt

• Take a look at examples folder

• Run examples from parent folder:

  PYTHONPATH=`pwd` python examples/request_data.py

• Before submit a merge requests, please check the static typing and tests.

• Install dev dependencies:

  pip install -r requirements_dev.txt

• Check static typing with mypy:

  make check

• Run all unit tests (builtin module unittest) with:

  make tests

• Run only some unit tests by passing a special ENV variable:

  make tests TESTS_FILTER=tests.documents.test_block.TestBlock.test_fromraw

Documentation

When writing docstrings, use the rst format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features

• Install Sphinx:

  pip install -r requirements_dev.txt

• Generate documentation:

  make docs

• HTML Documentation is generated in docs/_build/html folder.

• Examples are more fun than a TLTR doc

Packaging and deploy

Pypi

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/*