README.md 3.92 KB
Newer Older
1
<img src="https://git.duniter.org/clients/python/silkaj/raw/dev/logo/silkaj_logo.svg" width="250" />
Moul's avatar
Moul committed
2

3
4
5
6
7
8
# Silkaj
[![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)
[![Code format](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
9
[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/dev/coverage.svg)](https://clients.duniter.io/python/silkaj/index.html)
10
11
12
13
[![Website](https://img.shields.io/website/https/silkaj.duniter.org.svg)](https://silkaj.duniter.org)
[![Dev pipeline status](https://git.duniter.org/clients/python/silkaj/badges/dev/pipeline.svg)](https://git.duniter.org/clients/python/silkaj/)

Powerfull, lightweight, and multi-platform command line client written with Python for Ğ1 and Ğ1-Test currencies
14
- [Website](https://silkaj.duniter.org)
Moul's avatar
Moul committed
15

16
## Install
Moul's avatar
Moul committed
17
18
19
20
21
22
### Distribution
Install with your favorite package manager. See below the [packaging status paragraph](#packaging-status).

### Pip
If you want a more recent version [install with Pip](doc/install_pip.md):

23
```bash
24
pip3 install silkaj --user
25
26
```

Moul's avatar
Moul committed
27
28
29
### For contributing purposes
- [Install the Poetry development environment](doc/install_poetry.md)
- Check out the [contributing guidelines](CONTRIBUTING.md)
30

Moul's avatar
Moul committed
31
## Usage
32
- Get help usage with `-h` or `--help` options, then run:
Moul's avatar
Moul committed
33
```bash
34
silkaj <sub-command>
Moul's avatar
Moul committed
35
36
```

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

39
- Specify a custom node with `-p` option:
Moul's avatar
Moul committed
40
```bash
41
silkaj -p <address>:<port> <sub-command>
Moul's avatar
Moul committed
42
43
44
```

## Features
Moul's avatar
Moul committed
45
46
47
### Currency information & blockchain exploration
- Check the present currency information stand
- Display current proof of work difficulty level to generate the next block
48
49
50
- Explore the blockchain block by block

### Money management
Moul's avatar
Moul committed
51
52
53
54
- Transaction emission
  - Multi-recipients transaction support
- Consult wallets balances
- Consult wallet history
55

Moul's avatar
Moul committed
56
### Web-of-Trust management
Moul's avatar
Moul committed
57
- Look up for public keys and identities
58
- Check sent and received certifications and consult the membership status of any given identity in the Web of Trust
Moul's avatar
Moul committed
59
60
- Certification emission
- Membership emission
61
62

### Authentication
Moul's avatar
Moul committed
63
64
65
66
67
- Authentication methods: Scrypt, file, and (E)WIF

### Others
- Display Ğ1 monetary license
- Public key checksum
Moul's avatar
Moul committed
68

Moul's avatar
Moul committed
69
70
71
72
## 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
73
- [Ğ1Cotis](https://git.duniter.org/matograine/g1-cotis)
74
- [G1pourboire](https://git.duniter.org/matograine/g1pourboire)
Moul's avatar
Moul committed
75
76
- [Ğ1SMS](https://git.duniter.org/clients/G1SMS/)
- [Ğmixer](https://git.duniter.org/tuxmain/gmixer-py/)
Moul's avatar
Moul committed
77

78
### Dependencies
79
80
81
82
83
84
Silkaj is based on following Python modules:
- [Click](https://click.palletsprojects.com/): Composable command line interface toolkit
- [DuniterPy](https://git.duniter.org/clients/python/duniterpy/): Most complete client oriented Python library for Duniter/Ğ1 ecosystem
- [Pendulum](https://pendulum.eustace.io/): Datetimes made easy
- [texttable](https://github.com/foutaise/texttable/): Creation of simple ASCII tables
- [tabulate](https://github.com/astanin/python-tabulate): Pretty-print tabular data
85

Moul's avatar
Moul committed
86
87
88
89
90
91
### Names
I wanted to call that program:
- bamiyan
- margouillat
- lsociety
- cashmere
92
93

I finally called it `Silkaj` as `Silk` in esperanto.
94
95
96

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

## Packaging status
[![Packaging status](https://repology.org/badge/vertical-allrepos/silkaj.svg)](https://repology.org/project/silkaj/versions)