Metadata-Version: 2.1
Name: ape-addressbook
Version: 0.6.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
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
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
Requires-Python: >=3.8,<4
Description-Content-Type: text/markdown
Requires-Dist: eth-ape (<0.7,>=0.6.0)
Provides-Extra: dev
Requires-Dist: pytest (>=6.0) ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: hypothesis (<7.0,>=6.2.0) ; extra == 'dev'
Requires-Dist: black (>=22.12.0) ; extra == 'dev'
Requires-Dist: mypy (>=0.991) ; extra == 'dev'
Requires-Dist: types-setuptools ; extra == 'dev'
Requires-Dist: flake8 (>=5.0.4) ; extra == 'dev'
Requires-Dist: isort (>=5.10.1) ; extra == 'dev'
Requires-Dist: mdformat (>=0.7.16) ; extra == 'dev'
Requires-Dist: mdformat-gfm (>=0.3.5) ; extra == 'dev'
Requires-Dist: mdformat-frontmatter (>=0.4.1) ; extra == 'dev'
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: commitizen ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pytest-watch ; extra == 'dev'
Requires-Dist: IPython ; extra == 'dev'
Requires-Dist: ipdb ; extra == 'dev'
Provides-Extra: lint
Requires-Dist: black (>=22.12.0) ; extra == 'lint'
Requires-Dist: mypy (>=0.991) ; extra == 'lint'
Requires-Dist: types-setuptools ; extra == 'lint'
Requires-Dist: flake8 (>=5.0.4) ; extra == 'lint'
Requires-Dist: isort (>=5.10.1) ; extra == 'lint'
Requires-Dist: mdformat (>=0.7.16) ; extra == 'lint'
Requires-Dist: mdformat-gfm (>=0.3.5) ; extra == 'lint'
Requires-Dist: mdformat-frontmatter (>=0.4.1) ; extra == 'lint'
Provides-Extra: release
Requires-Dist: setuptools ; extra == 'release'
Requires-Dist: wheel ; extra == 'release'
Requires-Dist: twine ; extra == 'release'
Provides-Extra: test
Requires-Dist: pytest (>=6.0) ; extra == 'test'
Requires-Dist: pytest-xdist ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: hypothesis (<7.0,>=6.2.0) ; extra == 'test'

# Quick Start

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

## Dependencies

- [python3](https://www.python.org/downloads) version 3.8 or greater, python3-dev

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

You can also add global addresses:

```python
from ape_addressbook import addressbook

addressbook.set_global_entry("global_address", "0x2192f6112a026bce4047CeD2A16553Fd31E798B6")
```

## Development

This project is in development and should be considered a beta.
Things might not be in their final state and breaking changes may occur.
Comments, questions, criticisms and pull requests are welcomed.


