<img src="https://git.duniter.org/clients/python/silkaj/raw/main/logo/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://clients.pages.duniter.org/python/silkaj/index.html)
[![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/)
Powerfull, lightweight, and multi-platform command line client written with Python for Ğ1 and Ğ1-Test currencies
- [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](doc/install_pipx.md):
```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](doc/docker.md)
### For contributing purposes
- [Install the Poetry development environment](doc/install_poetry.md)
- Check out the [contributing guidelines](CONTRIBUTING.md)
## Usage
- Get help usage with `-h` or `--help` options, then run:
```bash
silkaj <sub-command>
```
- Will automatically request and post data on `duniter.org 443` main Ğ1 node.
- Specify a custom node with `-ep` option:
```bash
silkaj -ep <hostname>:<port> <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
- Verify blockchain blocks hashes
### 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
### Authentication
- Authentication methods: Scrypt, file, and (E)WIF
### Others
- Display Ğ1 monetary license
- Public key checksum
## Wrappers
- [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)
- [Ğ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.
### Website
- [Silkaj website sources](https://git.duniter.org/websites/silkaj_website/)
## Packaging status
[![Packaging status](https://repology.org/badge/vertical-allrepos/silkaj.svg)](https://repology.org/project/silkaj/versions)
Raw data
{
"_id": null,
"home_page": "https://silkaj.duniter.org",
"name": "silkaj",
"maintainer": "Moul",
"docs_url": null,
"requires_python": ">=3.8.0,<4.0.0",
"maintainer_email": "moul@moul.re",
"keywords": "g1,duniter,cryptocurrency,librecurrency,RTM",
"author": "Moul",
"author_email": "moul@moul.re",
"download_url": "https://files.pythonhosted.org/packages/d9/77/26eaeab39a780d34706c78f0cf444c373f5c2bd5d82a7a6a42e37558412e/silkaj-0.11.2.tar.gz",
"platform": null,
"description": "<img src=\"https://git.duniter.org/clients/python/silkaj/raw/main/logo/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://clients.pages.duniter.org/python/silkaj/index.html)\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\nPowerfull, lightweight, and multi-platform command line client written with Python for \u011e1 and \u011e1-Test currencies\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](doc/install_pipx.md):\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](doc/docker.md)\n\n### For contributing purposes\n\n- [Install the Poetry development environment](doc/install_poetry.md)\n- Check out the [contributing guidelines](CONTRIBUTING.md)\n\n## Usage\n\n- Get help usage with `-h` or `--help` options, then run:\n\n```bash\nsilkaj <sub-command>\n```\n\n- Will automatically request and post data on `duniter.org 443` main \u011e1 node.\n\n- Specify a custom node with `-ep` option:\n\n```bash\nsilkaj -ep <hostname>:<port> <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- Verify blockchain blocks hashes\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\n### Authentication\n\n- Authentication methods: Scrypt, file, and (E)WIF\n\n### Others\n\n- Display \u011e1 monetary license\n- Public key checksum\n\n## Wrappers\n\n- [How-to: automate transactions and multi-output](doc/how-to_automate_transactions_and_multi-output.md)\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### Website\n\n- [Silkaj website sources](https://git.duniter.org/websites/silkaj_website/)\n\n## Packaging status\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/silkaj.svg)](https://repology.org/project/silkaj/versions)\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "Powerfull, lightweight, and multi-platform command line client written with Python for Duniter\u2019s currencies: \u011e1 and \u011e1-Test.",
"version": "0.11.2",
"project_urls": {
"Changelog": "https://git.duniter.org/clients/python/silkaj/-/blob/main/CHANGELOG.md",
"Documentation": "https://git.duniter.org/clients/python/silkaj/tree/main/doc",
"Homepage": "https://silkaj.duniter.org",
"Repository": "https://git.duniter.org/clients/python/silkaj"
},
"split_keywords": [
"g1",
"duniter",
"cryptocurrency",
"librecurrency",
"rtm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e2a67264694fb1bdc9b3e8849343fe38747fc9443b7b604608d5f2d09df70b3",
"md5": "6bb60738b8c852f6af73c7aa337be6f6",
"sha256": "ad8a2f5d5b0913b98c8a52d12952e7706af2c89f23654220d110dfe5f16afb3e"
},
"downloads": -1,
"filename": "silkaj-0.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bb60738b8c852f6af73c7aa337be6f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0,<4.0.0",
"size": 83330,
"upload_time": "2023-11-22T20:30:07",
"upload_time_iso_8601": "2023-11-22T20:30:07.803215Z",
"url": "https://files.pythonhosted.org/packages/2e/2a/67264694fb1bdc9b3e8849343fe38747fc9443b7b604608d5f2d09df70b3/silkaj-0.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d97726eaeab39a780d34706c78f0cf444c373f5c2bd5d82a7a6a42e37558412e",
"md5": "c9896d2027f1981d9ed38574c208485b",
"sha256": "de4e4b95aa5627ff5226d778417f52f3dbd56242c4015066e1569121ed75eee6"
},
"downloads": -1,
"filename": "silkaj-0.11.2.tar.gz",
"has_sig": false,
"md5_digest": "c9896d2027f1981d9ed38574c208485b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0,<4.0.0",
"size": 60060,
"upload_time": "2023-11-22T20:30:09",
"upload_time_iso_8601": "2023-11-22T20:30:09.911053Z",
"url": "https://files.pythonhosted.org/packages/d9/77/26eaeab39a780d34706c78f0cf444c373f5c2bd5d82a7a6a42e37558412e/silkaj-0.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 20:30:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "silkaj"
}