# Quick Start
Ape plugin that allows tracking addresses and contracts in projects and globally.
## 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-addressbook
```
### 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-addressbook.git
cd ape-addressbook
python3 setup.py install
```
## Quick Usage
To use the addressbook in a project, add common addresses to your `ape-config.yaml` file like this:
```yaml
addressbook:
shared_account: "0x2192f6112a026bce4047CeD2A16553Fd31E798B6"
```
Then, to use the address, import the addressbook and access it via the alias set in the config:
```python
from ape_addressbook import addressbook
address = addressbook["shared_account"]
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/ape-addressbook",
"name": "ape-addressbook",
"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/d4/a8/14c04ca4a6ed23eabe6e4f0df4c9341889abe036334030d1cc2a300bb5f4/ape-addressbook-0.8.1.tar.gz",
"platform": null,
"description": "# Quick Start\n\nApe plugin that allows tracking addresses and contracts in projects and globally.\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-addressbook\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-addressbook.git\ncd ape-addressbook\npython3 setup.py install\n```\n\n## Quick Usage\n\nTo use the addressbook in a project, add common addresses to your `ape-config.yaml` file like this:\n\n```yaml\naddressbook:\n shared_account: \"0x2192f6112a026bce4047CeD2A16553Fd31E798B6\"\n```\n\nThen, to use the address, import the addressbook and access it via the alias set in the config:\n\n```python\nfrom ape_addressbook import addressbook\n\naddress = addressbook[\"shared_account\"]\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ape-addressbook: Ape plugin that allows tracking addresses and contracts",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-addressbook"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef1c5a35af9056b1c47233a50956cca9b43126478058a849cae3dfbbf9216e99",
"md5": "3584c1f5f31d64065aa69b81fc778c0f",
"sha256": "6c9a63cdfd14d87e4dc3318d9a7609509140305c49d2e2af8b1a1d660ef82816"
},
"downloads": -1,
"filename": "ape_addressbook-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3584c1f5f31d64065aa69b81fc778c0f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 9050,
"upload_time": "2024-11-14T09:18:34",
"upload_time_iso_8601": "2024-11-14T09:18:34.166651Z",
"url": "https://files.pythonhosted.org/packages/ef/1c/5a35af9056b1c47233a50956cca9b43126478058a849cae3dfbbf9216e99/ape_addressbook-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d4a814c04ca4a6ed23eabe6e4f0df4c9341889abe036334030d1cc2a300bb5f4",
"md5": "1e553d4565d0752021af04ff3d9ce9db",
"sha256": "dccd834cc4d3ce40c3f90ed7d0d4f6df5783c5d273bfb4131859cff113642645"
},
"downloads": -1,
"filename": "ape-addressbook-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "1e553d4565d0752021af04ff3d9ce9db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 15514,
"upload_time": "2024-11-14T09:18:35",
"upload_time_iso_8601": "2024-11-14T09:18:35.756519Z",
"url": "https://files.pythonhosted.org/packages/d4/a8/14c04ca4a6ed23eabe6e4f0df4c9341889abe036334030d1cc2a300bb5f4/ape-addressbook-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 09:18:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-addressbook",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ape-addressbook"
}