Skip to content

Latest commit

 

History

History
134 lines (107 loc) · 4.58 KB

README.md

File metadata and controls

134 lines (107 loc) · 4.58 KB
Raw

DuniterPy

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.

Features

Network

  • 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

Blockchain

  • 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

Requirements

Installation

You can install DuniterPy and its dependencies with the following command:

pip3 install duniterpy --user

Install the development environment

Documentation

Online official automaticaly generated documentation

The examples folder contains scripts to help you!

How to generate and read locally the autodoc

  • Install Sphinx, included into the development dependencies:
poetry install
  • Generate documentation
poetry run make docs
  • The HTML documentation is generated in docs/_build/html folder.

Development

Black, the formatting tool, requires Python 3.6 or higher.

  • Install runtime dependencies
poetry install --no-dev
  • Have a look at the examples folder
  • Run examples from parent folder
poetry run python examples/request_data.py

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

  • Install dev dependencies

poetry install
  • Check static typing with mypy
make check
  • Run all unit tests (builtin unittest module) 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

Packaging and deploy

PyPI

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

./release.sh 0.42.3

Build the PyPI package in the dist folder

make build

Deploy the package to PyPI test repository (prefix the command with a space for the shell to not save it in its history system, since the command contains credentials)

[SPACE]make deploy_test PYPI_TEST_LOGIN=xxxx PYPI_TEST_PASSWORD=xxxx

Install the package from PyPI test repository

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ duniterpy

Deploy the package on the PyPI repository (prefix the command with a space for the shell to not save it in its history system, since the command contains credentials)

[SPACE]make deploy PYPI_LOGIN=xxxx PYPI_PASSWORD=xxxx

Packaging status

Packaging status