# Overview
Ape account plugin and CLI for [Turnkey](https://turnkey.com).
Recommended plugin for automation and use with the [Silverback Platform](https://silverback.apeworx.io).
## Dependencies
- [python3](https://www.python.org/downloads) version 3.9 up to 3.13.
## Installation
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install ape-turnkey
```
### 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-turnkey.git
cd ape-turnkey
python3 setup.py install
```
## Usage
In order to use this plugin, you will need the `TURNKEY_ORGANIZATION_ID`, `TURNKEY_API_PUBLIC_KEY`, and `TURNKEY_API_PRIVATE_KEY` variables.
You can see which account you are signed in with using the following command:
```sh
$ ape turnkey whoami
Logged in as '<your account nickname>' under '<organization name>'
```
After that, you can do actions like list your wallets:
```sh
$ ape turnkey wallets list
...
```
You can create a new wallet via:
```sh
$ ape turnkey wallets new turnkey-wallet ...
SUCCESS: Wallet ID '1234....beef' created!
```
You will then be able to use this wallet for signing messages and transactions with Ape now, for example:
```py
$ ape console
In[0]: acct = accounts.load("turnkey-wallet")
In[1]: acct.sign_message("Signing using the turnkey API!")
Out[1]: <MessageSignature v=0 r=... s=...>
```
## 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-turnkey",
"name": "ape-turnkey",
"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/09/a5/c09bfe99703fe9a2246ba9cdaeb38c9cc3ea5093004437ac09e84189390c/ape-turnkey-0.8.0a0.tar.gz",
"platform": null,
"description": "# Overview\n\nApe account plugin and CLI for [Turnkey](https://turnkey.com).\nRecommended plugin for automation and use with the [Silverback Platform](https://silverback.apeworx.io).\n\n## Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.9 up to 3.13.\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-turnkey\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-turnkey.git\ncd ape-turnkey\npython3 setup.py install\n```\n\n## Usage\n\nIn order to use this plugin, you will need the `TURNKEY_ORGANIZATION_ID`, `TURNKEY_API_PUBLIC_KEY`, and `TURNKEY_API_PRIVATE_KEY` variables.\nYou can see which account you are signed in with using the following command:\n\n```sh\n$ ape turnkey whoami\nLogged in as '<your account nickname>' under '<organization name>'\n```\n\nAfter that, you can do actions like list your wallets:\n\n```sh\n$ ape turnkey wallets list\n...\n```\n\nYou can create a new wallet via:\n\n```sh\n$ ape turnkey wallets new turnkey-wallet ...\nSUCCESS: Wallet ID '1234....beef' created!\n```\n\nYou will then be able to use this wallet for signing messages and transactions with Ape now, for example:\n\n```py\n$ ape console\n\n In[0]: acct = accounts.load(\"turnkey-wallet\")\n\n In[1]: acct.sign_message(\"Signing using the turnkey API!\")\nOut[1]: <MessageSignature v=0 r=... s=...>\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-turnkey: turnkey.com plugin for Ape",
"version": "0.8.0a0",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-turnkey"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff9ce5fa53798338390f0a1feb33ef46b1cfa976e8086fcb388e32372072427f",
"md5": "58cf9ea068894fc8e6e9533bee09df92",
"sha256": "331fb3fd08c7a8d2052ecde7bad3627ee07734176832a88740e5b92ebd2cbf6a"
},
"downloads": -1,
"filename": "ape_turnkey-0.8.0a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58cf9ea068894fc8e6e9533bee09df92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 13173,
"upload_time": "2025-04-25T16:32:01",
"upload_time_iso_8601": "2025-04-25T16:32:01.437017Z",
"url": "https://files.pythonhosted.org/packages/ff/9c/e5fa53798338390f0a1feb33ef46b1cfa976e8086fcb388e32372072427f/ape_turnkey-0.8.0a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09a5c09bfe99703fe9a2246ba9cdaeb38c9cc3ea5093004437ac09e84189390c",
"md5": "2666a9d9ec711c0bbe9da78d44705b3f",
"sha256": "61c822820c49680220c171ed76becde4ca84db56a5476ee303d0944e1d5ebb53"
},
"downloads": -1,
"filename": "ape-turnkey-0.8.0a0.tar.gz",
"has_sig": false,
"md5_digest": "2666a9d9ec711c0bbe9da78d44705b3f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 18341,
"upload_time": "2025-04-25T16:32:03",
"upload_time_iso_8601": "2025-04-25T16:32:03.965330Z",
"url": "https://files.pythonhosted.org/packages/09/a5/c09bfe99703fe9a2246ba9cdaeb38c9cc3ea5093004437ac09e84189390c/ape-turnkey-0.8.0a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-25 16:32:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-turnkey",
"github_not_found": true,
"lcname": "ape-turnkey"
}
JSON
