silkaj


Namesilkaj JSON
Version 0.12.1 PyPI version JSON
download
home_pagehttps://silkaj.duniter.org
SummaryCommand line client for Ğ1 libre-currency powered by Duniter
upload_time2025-07-08 14:43:57
maintainerMoul, Maël Azimi
docs_urlNone
authorMoul, Maël Azimi
requires_python<4.0,>=3.9
licenseAGPL-3.0-or-later
keywords g1 duniter cryptocurrency librecurrency rtm
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <img src="https://git.duniter.org/clients/python/silkaj/raw/main/docs/images/silkaj_logo.svg" width="250" />

# 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?logo=python&label=Python&logoColor=gold)](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/)
[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/main/coverage.svg)](https://silkaj.duniter.org/latest/coverage/)
[![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/main/pipeline.svg)](https://git.duniter.org/clients/python/silkaj/)
[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](http://www.mypy-lang.org/)
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

Command line client for Ğ1 libre-currency powered by Duniter

- [Website](https://silkaj.duniter.org)

## Install

### Distribution

Install with your favorite package manager. See below the [packaging status paragraph](#packaging-status).

### Pipx

If you want a more recent version [install with pipx](https://silkaj.duniter.org/latest/install/):

```bash
sudo apt install pipx
pipx install silkaj
```

### Docker images

There is two kind of images. One build with `pip` for user purposes, and one using Poetry for developer purposes.

- [Docker images](https://silkaj.duniter.org/latest/contributing/container_usage/)

### For contributing purposes

- [Install the Poetry development environment](https://silkaj.duniter.org/latest/contributing/install_poetry/)
- Check out the [contributing guidelines](https://silkaj.duniter.org/latest/contributing/)

## Usage

- Get help usage with `-h` or `--help` options, then run:

```bash
silkaj <sub-command>
```

Silkaj command line interface (CLI) is structured by groups of commands:

```sh
silkaj blockchain -h
silkaj money -h
silkaj money transfer -h
silkaj wot revocation -h
```

You can find commands at the root, such as `silkaj license`

- Will automatically request and post data on https://g1.duniter.org/node/summary official Ğ1 endpoint.

- Specify a custom node with `-ep` option where `<port>` and `<path>` are optional:

```bash
silkaj -ep <hostname>:<port>/<path> <sub-command>
```

## Features

### Currency information & blockchain exploration

- Check the present currency information stand
- Display current proof of work difficulty level to generate the next block
- Explore the blockchain block by block

### Money management

- Transaction emission
    - Multi-recipients transaction support
    - Read transaction recipients and amounts from a file
- Consult wallets balances
- Consult wallet history

### Web-of-Trust management

- Look up for public keys and identities
- Check sent and received certifications and consult the membership status of any given identity in the Web of Trust
- Certification emission
- Membership emission
- Revocation file handling
- [DeathReaper: exclusions reports on Discourse forums](https://silkaj.duniter.org/latest/usage/deathreaper/)

### Authentication

- Authentication methods: Scrypt, Seedhex, PubSec, and (E)WIF

### Others

- Account storage
- Display Ğ1 monetary license
- Public key checksum

## Wrappers

- [Multi-recipients transfers and automation](https://silkaj.duniter.org/latest/usage/multi-recipients_transfers_and_automation)
- [Transaction generator written in Shell](https://gitlab.com/jytou/tgen)
- [Ğ1Cotis](https://git.duniter.org/matograine/g1-cotis)
- [G1pourboire](https://git.duniter.org/matograine/g1pourboire)
- [Ğ1SMS](https://git.duniter.org/clients/G1SMS/)
- [Ğmixer](https://git.duniter.org/tuxmain/gmixer-py/)
- [printqrjune](https://github.com/jbar/printqrjune)

### Dependencies

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

### Names

I wanted to call that program:

- bamiyan
- margouillat
- lsociety
- cashmere

I finally called it `Silkaj` as `Silk` in esperanto.

## Packaging status

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

Raw data

            {
    "_id": null,
    "home_page": "https://silkaj.duniter.org",
    "name": "silkaj",
    "maintainer": "Moul, Ma\u00ebl Azimi",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": "mael.azimi@moul.re",
    "keywords": "g1, duniter, cryptocurrency, librecurrency, RTM",
    "author": "Moul, Ma\u00ebl Azimi",
    "author_email": "mael.azimi@moul.re",
    "download_url": "https://files.pythonhosted.org/packages/79/9d/ca374ce87644ba35d08a48ea76d936aaf26bb386c8bf47e6a3f72474a4dd/silkaj-0.12.1.tar.gz",
    "platform": null,
    "description": "<img src=\"https://git.duniter.org/clients/python/silkaj/raw/main/docs/images/silkaj_logo.svg\" width=\"250\" />\n\n# Silkaj\n\n[![Version](https://img.shields.io/pypi/v/silkaj.svg)](https://pypi.python.org/pypi/silkaj)\n[![License](https://img.shields.io/pypi/l/silkaj.svg)](https://pypi.python.org/pypi/silkaj)\n[![Python versions](https://img.shields.io/pypi/pyversions/silkaj.svg?logo=python&label=Python&logoColor=gold)](https://pypi.python.org/pypi/silkaj)\n[![Code format](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![Coverage report](https://git.duniter.org/clients/python/silkaj/badges/main/coverage.svg)](https://silkaj.duniter.org/latest/coverage/)\n[![Website](https://img.shields.io/website/https/silkaj.duniter.org.svg)](https://silkaj.duniter.org)\n[![Dev pipeline status](https://git.duniter.org/clients/python/silkaj/badges/main/pipeline.svg)](https://git.duniter.org/clients/python/silkaj/)\n[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](http://www.mypy-lang.org/)\n[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)\n\nCommand line client for \u011e1 libre-currency powered by Duniter\n\n- [Website](https://silkaj.duniter.org)\n\n## Install\n\n### Distribution\n\nInstall with your favorite package manager. See below the [packaging status paragraph](#packaging-status).\n\n### Pipx\n\nIf you want a more recent version [install with pipx](https://silkaj.duniter.org/latest/install/):\n\n```bash\nsudo apt install pipx\npipx install silkaj\n```\n\n### Docker images\n\nThere is two kind of images. One build with `pip` for user purposes, and one using Poetry for developer purposes.\n\n- [Docker images](https://silkaj.duniter.org/latest/contributing/container_usage/)\n\n### For contributing purposes\n\n- [Install the Poetry development environment](https://silkaj.duniter.org/latest/contributing/install_poetry/)\n- Check out the [contributing guidelines](https://silkaj.duniter.org/latest/contributing/)\n\n## Usage\n\n- Get help usage with `-h` or `--help` options, then run:\n\n```bash\nsilkaj <sub-command>\n```\n\nSilkaj command line interface (CLI) is structured by groups of commands:\n\n```sh\nsilkaj blockchain -h\nsilkaj money -h\nsilkaj money transfer -h\nsilkaj wot revocation -h\n```\n\nYou can find commands at the root, such as `silkaj license`\n\n- Will automatically request and post data on https://g1.duniter.org/node/summary official \u011e1 endpoint.\n\n- Specify a custom node with `-ep` option where `<port>` and `<path>` are optional:\n\n```bash\nsilkaj -ep <hostname>:<port>/<path> <sub-command>\n```\n\n## Features\n\n### Currency information & blockchain exploration\n\n- Check the present currency information stand\n- Display current proof of work difficulty level to generate the next block\n- Explore the blockchain block by block\n\n### Money management\n\n- Transaction emission\n    - Multi-recipients transaction support\n    - Read transaction recipients and amounts from a file\n- Consult wallets balances\n- Consult wallet history\n\n### Web-of-Trust management\n\n- Look up for public keys and identities\n- Check sent and received certifications and consult the membership status of any given identity in the Web of Trust\n- Certification emission\n- Membership emission\n- Revocation file handling\n- [DeathReaper: exclusions reports on Discourse forums](https://silkaj.duniter.org/latest/usage/deathreaper/)\n\n### Authentication\n\n- Authentication methods: Scrypt, Seedhex, PubSec, and (E)WIF\n\n### Others\n\n- Account storage\n- Display \u011e1 monetary license\n- Public key checksum\n\n## Wrappers\n\n- [Multi-recipients transfers and automation](https://silkaj.duniter.org/latest/usage/multi-recipients_transfers_and_automation)\n- [Transaction generator written in Shell](https://gitlab.com/jytou/tgen)\n- [\u011e1Cotis](https://git.duniter.org/matograine/g1-cotis)\n- [G1pourboire](https://git.duniter.org/matograine/g1pourboire)\n- [\u011e1SMS](https://git.duniter.org/clients/G1SMS/)\n- [\u011emixer](https://git.duniter.org/tuxmain/gmixer-py/)\n- [printqrjune](https://github.com/jbar/printqrjune)\n\n### Dependencies\n\nSilkaj is based on following Python modules:\n\n- [Click](https://click.palletsprojects.com/): Composable command line interface toolkit\n- [DuniterPy](https://git.duniter.org/clients/python/duniterpy/): Most complete client oriented Python library for Duniter/\u011e1 ecosystem\n- [Pendulum](https://pendulum.eustace.io/): Datetimes made easy\n- [texttable](https://github.com/foutaise/texttable/): Creation of simple ASCII tables\n\n### Names\n\nI wanted to call that program:\n\n- bamiyan\n- margouillat\n- lsociety\n- cashmere\n\nI finally called it `Silkaj` as `Silk` in esperanto.\n\n## Packaging status\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/silkaj.svg?columns=2)](https://repology.org/project/silkaj/versions)\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-or-later",
    "summary": "Command line client for \u011e1 libre-currency powered by Duniter",
    "version": "0.12.1",
    "project_urls": {
        "Documentation": "https://silkaj.duniter.org/latest/",
        "Homepage": "https://silkaj.duniter.org",
        "Repository": "https://git.duniter.org/clients/python/silkaj",
        "changelog": "https://silkaj.duniter.org/latest/changelog/"
    },
    "split_keywords": [
        "g1",
        " duniter",
        " cryptocurrency",
        " librecurrency",
        " rtm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6a434a968b4490f7f1567fd3819cc05e38cd8986eceb2e023bbce5ec2cd987ca",
                "md5": "cd740ac6494311acbb810c4d6cec2838",
                "sha256": "75391453de31f10b73e4ed3ccf098a75f90f883f1e8d0e6cc0f39b5df3167d2e"
            },
            "downloads": -1,
            "filename": "silkaj-0.12.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cd740ac6494311acbb810c4d6cec2838",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 95390,
            "upload_time": "2025-07-08T14:43:56",
            "upload_time_iso_8601": "2025-07-08T14:43:56.549442Z",
            "url": "https://files.pythonhosted.org/packages/6a/43/4a968b4490f7f1567fd3819cc05e38cd8986eceb2e023bbce5ec2cd987ca/silkaj-0.12.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "799dca374ce87644ba35d08a48ea76d936aaf26bb386c8bf47e6a3f72474a4dd",
                "md5": "3d7253cd2694d55194ef19cc08ab1f70",
                "sha256": "a8534e4ae57b0f0709bd514488d5b491031e4888a5325485a06ad1798bf2a227"
            },
            "downloads": -1,
            "filename": "silkaj-0.12.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3d7253cd2694d55194ef19cc08ab1f70",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 66848,
            "upload_time": "2025-07-08T14:43:57",
            "upload_time_iso_8601": "2025-07-08T14:43:57.751092Z",
            "url": "https://files.pythonhosted.org/packages/79/9d/ca374ce87644ba35d08a48ea76d936aaf26bb386c8bf47e6a3f72474a4dd/silkaj-0.12.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 14:43:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "silkaj"
}
Moul, Maël Azimi
Elapsed time: 0.41105s