Python implementation of [Duniter](https://git.duniter.org/nodes/typescript/duniter) BMA API
Python implementation for[Duniter](https://git.duniter.org/nodes/typescript/duniter) BMA API
This is the most complete python library to communicate with Duniter nodes endpoints.
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.
This library is used by two clients:
-[Sakia](http://sakia-wallet.org/), the rich client to manage your Duniter's wallets.
-[Silkaj](https://silkaj.duniter.org/), the command line client.
## Features
## Features
- 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)
- 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/common/doc/blob/master/rfc/0009_Duniter_Blockchain_Protocol_V11.md)
- Asynchronous/synchronous without threads
- Asynchronous/synchronous without threads
- Support HTTP, HTTPS and Web Socket transport for BMA API
- Support HTTP, HTTPS and Web Socket transport for the BMA API
- Support [Elasticsearch Duniter4j](https://git.duniter.org/clients/java/duniter4j/blob/master/src/site/markdown/ES.md#request-the-es-node>) 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
- Duniter signing key
- Sign/verify and encrypt/decrypt messages with the Duniter credentials
- Sign/verify and encrypt/decrypt messages with the Duniter credentials
You can install duniter-python-api and all its dependencies via the following pip install
You can install DuniterPy and its dependencies with the following command:
```bash
```bash
pip3 install duniterpy
pip3 install duniterpy--user
```
```
## Documentation
## Documentation
Online official autodoc documentation: https://clients.duniter.io/python/duniterpy/index.html
Online official automaticaly generated documentation: https://clients.duniter.io/python/duniterpy/index.html
[Examples folder](https://git.duniter.org/clients/python/duniterpy/tree/master/examples)is full of scripts to help you!
The [examples folder](https://git.duniter.org/clients/python/duniterpy/tree/master/examples)contains scripts to help you!
Please take a look at the document [HTTP API](https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/HTTP_API.md)
Please take a look at the document [HTTP API](https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/HTTP_API.md) to learn more about the BMA API.
* Run all unit tests (builtin module unittest) with
* Run all unit tests (builtin `unittest` module) with:
```bash
```bash
make tests
make tests
```
```
* Run only some unit tests by passing a special ENV variable
* Run only some unit tests by passing a special ENV variable:
```bash
```bash
make tests TESTS_FILTER=tests.documents.test_block.TestBlock.test_fromraw
make tests TESTS_FILTER=tests.documents.test_block.TestBlock.test_fromraw
```
```
## Packaging and deploy
## Packaging and deploy
### Pypi
### PyPi
In the development pyenv environment, install the build and deploy tools
In the development pyenv environment, install the tools to build and deploy
```bash
```bash
pip install--upgrade-r requirements_deploy.txt
pip install--upgrade-r requirements_deploy.txt
```
```
...
@@ -106,22 +107,22 @@ Change and commit and tag the new version number (semantic version number)
...
@@ -106,22 +107,22 @@ Change and commit and tag the new version number (semantic version number)
./release.sh 0.42.3
./release.sh 0.42.3
```
```
Build the Pypi package in the ``dist`` folder
Build the PyPi package in the `dist` folder
```bash
```bash
make build
make build
```
```
Deploy the package on the Pypi test repository (use a space before make to not keep command with password in shell history)
Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
Deploy the package on the Pypi repository (use a space before make to not keep command with password in shell history)
Deploy the package on the PyPi repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)