Skip to content
Snippets Groups Projects

Improve Readme, config

Merged Moul requested to merge readme_config into dev
Files
2
+ 11
8
@@ -4,9 +4,12 @@ Python implementation for [Duniter](https://git.duniter.org/nodes/typescript/dun
This is the most complete Python library to communicate with Duniter nodes endpoints.
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.
This library was originally developed for [Sakia](http://sakia-wallet.org/) desktop client which is now discontinued.
It is currently used by following programms:
- [Tikka](https://git.duniter.org/clients/python), the desktop client.
- [Silkaj](https://silkaj.duniter.org/), command line client.
- [Jaklis](https://git.p2p.legal/axiom-team/jaklis), command line client.
- [Ğ1Dons](https://git.duniter.org/matograine/g1pourboire), tools.
## 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/common/doc/blob/master/rfc/0009_Duniter_Blockchain_Protocol_V11.md)
@@ -99,28 +102,28 @@ make tests TESTS_FILTER=tests.documents.test_block.TestBlock.test_fromraw
```
## Packaging and deploy
### PyPi
### PyPI
Change and commit and tag the new version number (semantic version number)
```bash
./release.sh 0.42.3
```
Build the PyPi package in the `dist` folder
Build the PyPI package in the `dist` folder
```bash
make build
```
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 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)
```bash
[SPACE]make deploy_test PYPI_TEST_LOGIN=xxxx PYPI_TEST_PASSWORD=xxxx
```
Install the package from PyPi test repository
Install the package from PyPI test repository
```bash
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 in order for the shell not to save in its history system the command containing the password)
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)
```bash
[SPACE]make deploy PYPI_LOGIN=xxxx PYPI_PASSWORD=xxxx
```
Loading