Skip to content
Snippets Groups Projects
Commit 2326b1d9 authored by Vincent Texier's avatar Vincent Texier
Browse files

issue #55 improve documentation index.rst and Readme.rst

parent 920564ed
No related branches found
No related tags found
No related merge requests found
Pipeline #2719 passed
......@@ -6,11 +6,17 @@ Duniter Python API
Python implementation of `Duniter <https://git.duniter.org/nodes/typescript/duniter>`_ BMA API
This is the most complete python library to communicate with Duniter nodes endpoints.
This library is used by `Sakia <http://sakia-wallet.org/>`_, the rich client to manage your Duniter's wallets.
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
* Support 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/synchronous without threads
* Support HTTP, HTTPS and Web Socket transport for BMA API
* Support `Elasticsearch Duniter4j <https://git.duniter.org/clients/java/duniter4j/blob/master/src/site/markdown/ES.md#request-the-es-node>`_ API
* Duniter signing key
Requirements
......
......@@ -6,8 +6,9 @@
duniterpy : A python implementation of duniter API
==================================================
duniterpy is a library to develop an application for duniter.
duniterpy helps to handle the following problem :
Duniterpy is a library to develop an client Python application for Duniter.
Duniterpy helps to handle the following problem :
* Request Basic Merkle API provided by duniter nodes
* Request nodes in a non-blocking way
* Handle duniter signing keys
......@@ -17,12 +18,12 @@ Installation
Simply type::
$ pip install duniterpy
$ pip3 install duniterpy
Source code
-----------
Sources can be found at https://github.com/duniter/duniter-python-api
Sources can be found at https://git.duniter.org/clients/python/duniterpy
Contributions are welcome.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment