Metadata-Version: 2.1
Name: ape-addressbook
Version: 0.7.0
Summary: ape-addressbook: Ape plugin that allows tracking addresses and contracts
Home-page: https://github.com/ApeWorX/ape-addressbook
Author: ApeWorX Ltd.
Author-email: admin@apeworx.io
License: Apache-2.0
Keywords: ethereum
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8,<4
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: lint
Provides-Extra: release
Provides-Extra: dev
License-File: LICENSE

# Quick Start

Ape plugin that allows tracking addresses and contracts in projects and globally.

## Dependencies

- [python3](https://www.python.org/downloads) version 3.8 up to 3.11.

## 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"]
```
