Python library for developers of Duniter clients
Project description
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
- Python >= 3.7.0
- websocket-client
- jsonschema
- pyPEG2
- attrs
- base58
- libnacl
- pyaes
Installation
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
Documentation
Online official automaticaly generated documentation
Examples
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/request_data.py
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
Development
-
When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
-
Use
make check
commands to check the code and the format. -
Install runtime dependencies
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
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:
make deploy_test
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:
make deploy
Packaging status
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for duniterpy-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef3d2331c3d330741edc25dde37cfa6a41f1dac12f1fbb60cb8532f25cc9f44c |
|
MD5 | aae45f205ce7a8f86cd23997408051f7 |
|
BLAKE2b-256 | a2789375326fd948eba079a9cc98ad64da2974a1d28acfddfbc8d1e1953fa016 |