Skip to main content

Ape Ethereum Framework

Project description

Pypi.org Apache licensed Build Status Discord chat Twitter

Overview

Ape Framework is an easy-to-use Web3 development tool. Users can compile, test, and interact with smart contracts all in one command line session. With our modular plugin system, Ape supports multiple contract languages and chains.

Ape is built by ApeWorX LTD.

Join our ApeWorX Discord server to stay up to date on new releases, plugins, and tutorials.

If you want to get started now, see the Quickstart section.

Documentation

Read our technical documentation to get a deeper understanding of our open source Framework.

Read our academic platform will help you master Ape Framework with tutorials and challenges.

Prerequisite

In the latest release, Ape requires:

  • Linux or macOS
  • Python 3.9 up to 3.12
  • Windows: Install Windows Subsystem Linux (WSL)

Check your python version in a terminal with python3 --version.

Installation

There are three ways to install ape: pipx, pip, or Docker.

Considerations for Installing

  • If using pip, we advise using the most up-to-date version of pip to increase the chance of a successful installation.

  • We advise installing in a virtualenv or venv to avoid interfering with OS-level site packages.

  • We advise installing ape with recommended plugins pip install eth-ape'[recommended-plugins]'.

  • We advise for macOS users to install virtual env via homebrew.

Installing with pipx or pip

  1. Install pipx via their installation instructions or pip via their installation instructions.

  2. Install ape via pipx install eth-ape or pip install eth-ape.

Installing with docker

Ape can also run in a docker container.

You can pull our images from ghcr. This image is built using our recommended-plugins extra, so it is a great starting point for running ape in a containerized environment.

We also have a slim docker image that is built without any installed plugins. This image is meant for production support and must be further configured if any plugins are in use.

You can pull the image:

$ docker pull ghcr.io/apeworx/ape:latest  # installs with recommended-plugins

or pull the slim if you have specific needs that you'd like to build from:

$ docker pull ghcr.io/apeworx/ape:latest-slim  # installs ape with required packages

or build the image locally from source:

$ docker build -t ape:latest-slim -f Dockerfile.slim .
$ docker build -t ape:latest .

An example of running a command from the container would be:

docker run \
  --volume $HOME/.ape:/home/harambe/.ape \
  --volume $HOME/.vvm:/home/harambe/.vvm \
  --volume $HOME/.solcx:/home/harambe/.solcx \
  --volume $PWD:/home/harambe/project \
  apeworx/ape compile

Note: The above command requires the full install which includes recommended-plugins installation extra.

Quickstart

After you have installed Ape, run ape --version to verify the installation was successful.

Interact with Ape using either the CLI or Python code.

See the following user-guides for more in-depth tutorials:

Plugin System

Ape's modular plugin system allows users to have an interoperable experience with Web3.

If a plugin does not originate from the [ApeWorX GitHub Organization](https://github.com/ApeWorX?q=ape&type=all), you will get a warning about installing 3rd-party plugins.
Install 3rd party plugins at your own risk.

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.8.20.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

eth_ape-0.8.20-py3-none-any.whl (379.2 kB view details)

Uploaded Python 3

File details

Details for the file eth-ape-0.8.20.tar.gz.

File metadata

  • Download URL: eth-ape-0.8.20.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.2 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.67.0 importlib-metadata/8.5.0 keyring/25.5.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

File hashes

Hashes for eth-ape-0.8.20.tar.gz
Algorithm Hash digest
SHA256 b4044a9490d35f6a5af52a105ce0d7bc2c968906831989b7906a9c2ce050582b
MD5 99f7c2a85c20bfb3d892209a96b4c70f
BLAKE2b-256 cb68c8d1c041d3928392e9375810d966c8b423dde51ddf555a07732fa9cc18c5

See more details on using hashes here.

Provenance

File details

Details for the file eth_ape-0.8.20-py3-none-any.whl.

File metadata

  • Download URL: eth_ape-0.8.20-py3-none-any.whl
  • Upload date:
  • Size: 379.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.2 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.67.0 importlib-metadata/8.5.0 keyring/25.5.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

File hashes

Hashes for eth_ape-0.8.20-py3-none-any.whl
Algorithm Hash digest
SHA256 4da458c08482e0df6a7f400e00536aac60032fa25efd042ffd15b9e8ce32a6c1
MD5 928a09c50edc646f56b946a9e6b16702
BLAKE2b-256 0fb48ef8376e922dd2bb02b7f6ed158bc4a93c28a4df4b5ff05d4a04c5d14260

See more details on using hashes here.

Provenance

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