# Quick Start
Ape Ledger is a plugin for Ape Framework which integrates with Ledger devices
to load and create accounts, sign messages, and sign transactions.
## Dependencies
- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.
## Installation
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install ape-ledger
```
### via `setuptools`
You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
```bash
git clone https://github.com/ApeWorX/ape-ledger.git
cd ape-ledger
python3 setup.py install
```
## Quick Usage
You must:
- have the Ledger USB device connected
- have the Ledger USB device unlocked (by entering the passcode)
- and have the Ethereum app open.
Then, add accounts:
```bash
ape ledger add <alias>
```
Ledger accounts have the following capabilities in `ape`:
1. Can sign transactions
2. Can sign messages using the default EIP-191 specification
3. Can sign messages using the EIP-712 specification
### Adjust HD Path
If you need to adjust your HD path, use the `--hd-path` flag when adding the account.
```bash
ape ledger add <alias> --hd-path "m/44'/60'/0'/0/{x}"
```
`{x}` indicates the account node. Note that excluding `{x}` assumes the account node is at the end
of the path.
The default HD path for the Ledger plugin is `m/44'/60'/{x}'/0/0`.
See https://github.com/MyCryptoHQ/MyCrypto/issues/2070 for more information.
## List accounts
To list just your Ledger accounts in `ape`, do:
```bash
ape ledger list
```
## Remove accounts
You can also remove accounts:
```bash
ape ledger delete <alias>
```
## Development
Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
Comments, questions, criticisms and pull requests are welcomed.
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/ape-ledger",
"name": "ape-ledger",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "ethereum",
"author": "ApeWorX Ltd.",
"author_email": "admin@apeworx.io",
"download_url": "https://files.pythonhosted.org/packages/55/00/b753642ddaefa0b0caa2c1225d2ab155fbfcc89ecc0ede30b07016c6b24d/ape-ledger-0.8.1.tar.gz",
"platform": null,
"description": "# Quick Start\n\nApe Ledger is a plugin for Ape Framework which integrates with Ledger devices\nto load and create accounts, sign messages, and sign transactions.\n\n## Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.\n\n## Installation\n\n### via `pip`\n\nYou can install the latest release via [`pip`](https://pypi.org/project/pip/):\n\n```bash\npip install ape-ledger\n```\n\n### via `setuptools`\n\nYou can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:\n\n```bash\ngit clone https://github.com/ApeWorX/ape-ledger.git\ncd ape-ledger\npython3 setup.py install\n```\n\n## Quick Usage\n\nYou must:\n\n- have the Ledger USB device connected\n- have the Ledger USB device unlocked (by entering the passcode)\n- and have the Ethereum app open.\n\nThen, add accounts:\n\n```bash\nape ledger add <alias>\n```\n\nLedger accounts have the following capabilities in `ape`:\n\n1. Can sign transactions\n2. Can sign messages using the default EIP-191 specification\n3. Can sign messages using the EIP-712 specification\n\n### Adjust HD Path\n\nIf you need to adjust your HD path, use the `--hd-path` flag when adding the account.\n\n```bash\nape ledger add <alias> --hd-path \"m/44'/60'/0'/0/{x}\"\n```\n\n`{x}` indicates the account node. Note that excluding `{x}` assumes the account node is at the end\nof the path.\n\nThe default HD path for the Ledger plugin is `m/44'/60'/{x}'/0/0`.\nSee https://github.com/MyCryptoHQ/MyCrypto/issues/2070 for more information.\n\n## List accounts\n\nTo list just your Ledger accounts in `ape`, do:\n\n```bash\nape ledger list\n```\n\n## Remove accounts\n\nYou can also remove accounts:\n\n```bash\nape ledger delete <alias>\n```\n\n## Development\n\nPlease see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.\nComments, questions, criticisms and pull requests are welcomed.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ape-ledger: Plugin for Ledger Hardware Wallet",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-ledger"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4224821cb7c0a2a26970bca0ecc5d85fe2a6fa97abdb1e3c94adef91d02640ac",
"md5": "022c5e4446cbeca8563a27ff6fadb517",
"sha256": "728da734134165e923a0b52da5d750f7c85fa0a5a57fb1a82be1debe32611b45"
},
"downloads": -1,
"filename": "ape_ledger-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "022c5e4446cbeca8563a27ff6fadb517",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 16344,
"upload_time": "2024-10-29T16:27:08",
"upload_time_iso_8601": "2024-10-29T16:27:08.270729Z",
"url": "https://files.pythonhosted.org/packages/42/24/821cb7c0a2a26970bca0ecc5d85fe2a6fa97abdb1e3c94adef91d02640ac/ape_ledger-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5500b753642ddaefa0b0caa2c1225d2ab155fbfcc89ecc0ede30b07016c6b24d",
"md5": "0b574181d447e18519e0d49d9029deb2",
"sha256": "1f3ff0817a51287bf24ffde430f08800b8b1f95361050edb68d966733d31b00a"
},
"downloads": -1,
"filename": "ape-ledger-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "0b574181d447e18519e0d49d9029deb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 27890,
"upload_time": "2024-10-29T16:27:09",
"upload_time_iso_8601": "2024-10-29T16:27:09.679252Z",
"url": "https://files.pythonhosted.org/packages/55/00/b753642ddaefa0b0caa2c1225d2ab155fbfcc89ecc0ede30b07016c6b24d/ape-ledger-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 16:27:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-ledger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ape-ledger"
}
JSON
