Ape Ethereum Framework
Project description
Ape Framework
Ape is a framework for Web3 Python applications and smart contracts, with advanced functionality for testing, deployment, and on-chain interactions.
See website and documentation.
Dependencies
- python3 version 3.7 or greater, python3-dev
Installation
via pip
You can install the latest release via pip:
pip install eth-ape
via setuptools
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/ape.git
cd ape
python3 setup.py install
via docker
Please visit our Dockerhub for more details on using Ape with Docker.
example commands:
compiling:
docker run \
--volume $HOME/.ape:/root/.ape \
--volume $HOME/.vvm:/root/.vvm \
--volume $HOME/.solcx:/root/.solcx \
--volume $PWD:/root/project \
--workdir /root/project \
apeworx/ape compile
running the ape console:
docker run -it \
--volume $HOME/.ape:/root/.ape \
--volume $HOME/.vvm:/root/.vvm \
--volume $HOME/.solcx:/root/.solcx \
--volume $PWD:/root/project \
--workdir /root/project \
apeworx/ape console
Quick Usage
Ape is primarily meant to be used as a command line tool. Here are some things you can use ape to do:
# Work with your accounts
$ ape accounts list
# Compile your project's smart contracts
$ ape compile --size
# Run your tests with pytest
$ ape test -k test_only_one_thing --coverage --gas
# Connect an IPython session through your favorite provider
$ ape console --network ethereum:mainnet:infura
# Add new plugins to ape
$ ape plugins add plugin-name
Ape also works as a package. You can use the same networks, accounts, and projects from the ape package as you can in the cli:
# Work with registered networks, providers, and blockchain ecosystems (like Ethereum)
from ape import networks
with networks.ethereum.mainnet.use_provider("infura"):
... # Work with the infura provider here
# Work with test accounts, local accounts, and (WIP) popular hardware wallets
from ape import accounts
a = accounts[0] # Load by index
a = accounts["example.eth"] # or load by ENS/address
a = accounts.load("alias") # or load by alias
# Work with contract types
from ape import project
c = a.deploy(project.MyContract, ...)
c.viewThis() # Make Web3 calls
c.doThat(sender=a) # Make Web3 transactions
assert c.MyEvent[-1].caller == a # Search through Web3 events
Development
This project is in early development and should be considered an alpha. Things might not work, breaking changes are likely. Comments, questions, criticisms and pull requests are welcomed.
Documentation
To build docs:
python build_docs.py # build docs in docs/_build
python build_docs.py --rsync=/tmp/ape # for serving up docs in development
License
This project is licensed under the Apache 2.0.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file eth-ape-0.1.0a31.tar.gz.
File metadata
- Download URL: eth-ape-0.1.0a31.tar.gz
- Upload date:
- Size: 107.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 067031202fe735e27d079124ebadfcf310484075d2b39324b42306fa70fba53e |
|
| MD5 | 080045b18cd880314e9ea562f9355c80 |
|
| BLAKE2b-256 | 3a2213b4cfefe521cc06dd4cf74979a7dbb02e29355e0b6a44d0f0aee80c1746 |
File details
Details for the file eth_ape-0.1.0a31-py3-none-any.whl.
File metadata
- Download URL: eth_ape-0.1.0a31-py3-none-any.whl
- Upload date:
- Size: 87.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 162259f60c26f4378d874a94778890e5e5c9adfa46761ff9414ae6f42a953892 |
|
| MD5 | 2f27e5d95650de4c4f5e4c1651df5a22 |
|
| BLAKE2b-256 | c9e5fde84d9e4b10a36a7c9e4f83cb7afc25daafc8d7fd101d3b0b9b3a88a051 |
