README.md 2.53 KB
Newer Older
Moul's avatar
Moul committed
1
# Silkaj
Moul's avatar
Moul committed
2
[![Version](https://img.shields.io/pypi/v/silkaj.svg)](https://pypi.python.org/pypi/silkaj) [![License](https://img.shields.io/pypi/l/silkaj.svg)](https://pypi.python.org/pypi/silkaj) [![Python versions](https://img.shields.io/pypi/pyversions/silkaj.svg)](https://pypi.python.org/pypi/silkaj)
Moul's avatar
Moul committed
3

4 5
- CLI Duniter client written with Python 3.
- [Website](https://silkaj.duniter.org)
Moul's avatar
Moul committed
6

7
## Install
8
```bash
9
pip3 install silkaj --user
10 11 12
```

- [Install with Pip](doc/install_pip.md)
13
- [Install the Development environment](doc/install_poetry.md)
14
- [Install with the build](doc/install_build.md)
15
- [Build an executable with Pyinstaller](doc/build_with_pyinstaller.md)
16

Moul's avatar
Moul committed
17
## Usage
18
- Get help usage with `-h` or `--help` options, then run:
Moul's avatar
Moul committed
19
```bash
20
silkaj <sub-command>
Moul's avatar
Moul committed
21 22
```

23
- Will automatically request and post data on `duniter.org 443` main Ğ1 node.
Moul's avatar
Moul committed
24

25
- Specify a custom node with `-p` option:
Moul's avatar
Moul committed
26
```bash
27
silkaj -p <address>:<port> <sub-command>
Moul's avatar
Moul committed
28 29 30
```

## Features
31
### Currency information
Moul's avatar
Moul committed
32
- Currency information
33 34 35 36 37
- Display the current Proof of Work difficulty level to generate the next block
- Check the current network
- Explore the blockchain block by block

### Money management
Tortue95's avatar
Tortue95 committed
38
- Send transaction
39 40 41 42 43 44 45 46 47
- Consult the wallet balance

### Money management
- Check sent and received certifications and consult the membership status of any given identity in the Web of Trust
- Check the present currency information stand
- Send certification

### Authentication
- Three authentication methods: Scrypt, file, and (E)WIF
Moul's avatar
Moul committed
48

Moul's avatar
Moul committed
49 50 51 52
## Wrappers
- [Install as a drop-down for GNOME Shell with Argos](doc/argos.md)
- [How-to: automate transactions and multi-output](doc/how-to_automate_transactions_and_multi-output.md)
- [Transaction generator written in Shell](https://gitlab.com/jytou/tgen)
Moul's avatar
Moul committed
53 54 55
- [Ğ1Cotis](https://git.duniter.org/matograine/g1-cotis)
- [Ğ1SMS](https://git.duniter.org/clients/G1SMS/)
- [Ğmixer](https://git.duniter.org/tuxmain/gmixer-py/)
Moul's avatar
Moul committed
56

57 58 59
### Dependencies
Silkaj is based on Python dependencies:

Moul's avatar
Moul committed
60
- [Click](https://click.palletsprojects.com/): Command Line Interface Creation Kit.
Moul's avatar
Moul committed
61
- [DuniterPy](https://git.duniter.org/clients/python/duniterpy/): Python APIs library to implement duniter clients softwares.
62 63 64
- [Tabulate](https://bitbucket.org/astanin/python-tabulate/overview): to display charts.
- [PyNaCl](https://github.com/pyca/pynacl/): Cryptography (NaCl) library.

Moul's avatar
Moul committed
65 66 67 68 69 70
### Names
I wanted to call that program:
- bamiyan
- margouillat
- lsociety
- cashmere
71 72

I finally called it `Silkaj` as `Silk` in esperanto.
73 74 75

### Website
- [Silkaj website sources](https://git.duniter.org/websites/silkaj_website/)