Skip to main content

Python library for developers of Duniter clients

Project description


Most complete client oriented Python library for Duniter/Ğ1 ecosystem.

This library was originally developed for Sakia desktop client which is now discontinued. It is currently used by following programs:

  • Tikka, the desktop client (Work In Progress, not yet available).
  • Silkaj, command line client.
  • Jaklis, command line client for Cs+/Gchange pods.
  • Ğ1Dons, Ğ1Dons, paper-wallet generator aimed at giving tips in Ğ1.



  • APIs support: BMA, GVA, WS2P, and CS+:
    • Basic Merkle API, first Duniter API to be deprecated
    • GraphQL Verification API, Duniter API in developement meant to replace BMA. Based on GraphQL.
    • Websocket to Peer, Duniter inter-nodes (servers) API
    • Cesium+, non-Duniter API, used to store profile data related to the blockchain as well as ads for Cesium and Ğchange.
  • Non-threaded asynchronous/synchronous connections
  • Support HTTP, HTTPS, and WebSocket transport for the APIs
  • Endpoints management


  • Support Duniter blockchain protocol
  • Duniter documents management: transaction, block and WoT documents
  • Multiple authentication methods
  • Duniter signing key
  • Sign/verify and encrypt/decrypt messages with Duniter credentials



You will require following dependencies:

sudo apt install python3-pip python3-dev python3-wheel libsodium23

You can install DuniterPy and its dependencies with following command:

pip3 install duniterpy --user

Install the development environment


Online official automaticaly generated documentation


The examples folder contains scripts to help you!

  • Have a look at the examples folder
  • Run examples from parent folder directly
poetry run python examples/

Or from Python interpreter:

poetry run python
>>> import examples
>>> help(examples)
>>> examples.create_public_key()

request_data_async example requires to be run with asyncio:

>>> import examples, asyncio
>>> asyncio.get_event_loop().run_until_complete(examples.request_data_async())

How to generate and read locally the autodoc

  • Install Sphinx, included into the development dependencies:
poetry install
  • Generate HTML documentation in public directory:
make docs


poetry install --no-dev
  • Before submitting a merge requests, please check the static typing and tests.

  • Install dev dependencies

poetry install
  • Check static typing with mypy
make mypy

Packaging and deploy


Change and commit and tag the new version number (semantic version number)

./ 0.42.3

Build the PyPI package in the dist folder

make build

Deploy the package to PyPI test repository:

make deploy_test

Install the package from PyPI test repository

pip install --index-url --extra-index-url duniterpy

Deploy the package on the PyPI repository:

make deploy

Packaging status

Packaging status

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

duniterpy-1.1.0.tar.gz (73.5 kB view hashes)

Uploaded source

Built Distribution

duniterpy-1.1.0-py3-none-any.whl (136.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page