Skip to main content

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.

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

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({"from": 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.

Project details


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

eth-ape-0.1.0a21.tar.gz (73.1 kB view details)

Uploaded Source

Built Distribution

eth_ape-0.1.0a21-py3-none-any.whl (59.5 kB view details)

Uploaded Python 3

File details

Details for the file eth-ape-0.1.0a21.tar.gz.

File metadata

  • Download URL: eth-ape-0.1.0a21.tar.gz
  • Upload date:
  • Size: 73.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.11

File hashes

Hashes for eth-ape-0.1.0a21.tar.gz
Algorithm Hash digest
SHA256 5cafdade30f25d7fcc31a55a49d6967c637d1fc52ae048c62a72b09860275b18
MD5 836a6c3c5bd17ef2d731ff2f37718f94
BLAKE2b-256 69f54eb80ad70d012ebbb10260b24c6cfb0a2b264ca8b60aeac2b54e10cc4b19

See more details on using hashes here.

File details

Details for the file eth_ape-0.1.0a21-py3-none-any.whl.

File metadata

  • Download URL: eth_ape-0.1.0a21-py3-none-any.whl
  • Upload date:
  • Size: 59.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.11

File hashes

Hashes for eth_ape-0.1.0a21-py3-none-any.whl
Algorithm Hash digest
SHA256 e87ad3abac8ce3be752a3bc2e54fbad5b7dc0125ef6583b2b5e186ba91d73261
MD5 47542453441809ce9b0361a4df2053e3
BLAKE2b-256 b06673244c3d2d2a677fc11fdb777b36afd4151efc561bca06af7525c96bedd7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page