Skip to main content

Pypi.org Apache licensed Build Status Contributing Discord chat Twitter DeepWiki

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 which will help you master Ape Framework with tutorials and challenges.

Prerequisite

In the latest release, Ape requires:

  • Linux or macOS
  • Python 3.10 up to 3.13
  • 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.

You can interact with Ape using the command line or the Ape console.

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.

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.51.tar.gz (744.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eth_ape-0.8.51-py3-none-any.whl (429.5 kB view details)

Uploaded Python 3

File details

Details for the file eth_ape-0.8.51.tar.gz.

File metadata

  • Download URL: eth_ape-0.8.51.tar.gz
  • Upload date:
  • Size: 744.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for eth_ape-0.8.51.tar.gz
Algorithm Hash digest
SHA256 d664197313382a67a9d976fd6b3ef1b81c0198cdb7b53b4bc48de5659eb8dad4
MD5 adca8d09e7564178cbfd5c9df0048125
BLAKE2b-256 d32916ed09f699fefef79b60c9125ac7348014f44a0c534e5ab5401975da8721

See more details on using hashes here.

Provenance

The following attestation bundles were made for eth_ape-0.8.51.tar.gz:

Publisher: publish.yaml on ApeWorX/ape

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: eth_ape-0.8.51-py3-none-any.whl
  • Upload date:
  • Size: 429.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for eth_ape-0.8.51-py3-none-any.whl
Algorithm Hash digest
SHA256 2e8f508b0aaa37a3696ef195d1595f99409201c132c22feafaefb7ac7f4b1f05
MD5 2cd180d44aaa05a72235680918802ce2
BLAKE2b-256 3c122df0741a108101369b641d989b903feec51cd2663e528982059df54bbab9

See more details on using hashes here.

Provenance

The following attestation bundles were made for eth_ape-0.8.51-py3-none-any.whl:

Publisher: publish.yaml on ApeWorX/ape

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.8.51 This release

2 files

0.8.50

2 files

0.8.49

2 files

0.8.48

2 files

0.8.47

2 files

0.8.46

2 files

0.8.45

2 files

0.8.44

2 files

0.8.43

2 files

0.8.42

2 files

0.8.41

2 files

0.8.40

2 files

0.8.39

2 files

0.8.38

2 files

0.8.37

2 files

0.8.36

2 files

0.8.35

2 files

0.8.34

2 files

0.8.33

2 files

0.8.32

2 files

0.8.31

2 files

0.8.30

2 files

0.8.29

2 files

0.8.28

2 files

0.8.27

2 files

0.8.26

2 files

0.8.25

2 files

0.8.24

2 files

0.8.23

2 files

0.8.22

2 files

0.8.21

2 files

0.8.20

2 files

0.8.19

2 files

0.8.18

2 files

0.8.17

2 files

0.8.16

2 files

0.8.15

2 files

0.8.14

2 files

0.8.13

2 files

0.8.12

2 files

0.8.11

2 files

0.8.10

2 files

0.8.9

2 files

0.8.8

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.23

2 files

0.7.22

2 files

0.7.21

2 files

0.7.20

2 files

0.7.19

2 files

0.7.18

2 files

0.7.17

2 files

0.7.16

2 files

0.7.15

2 files

0.7.14

2 files

0.7.13

2 files

0.7.12

2 files

0.7.11

2 files

0.7.10

2 files

0.7.9

2 files

0.7.8

2 files

0.7.7

2 files

0.7.6

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.27

2 files

0.6.26

2 files

0.6.25

2 files

0.6.24

2 files

0.6.23

2 files

0.6.22

2 files

0.6.21

2 files

0.6.20

2 files

0.6.19

2 files

0.6.18

2 files

0.6.17

2 files

0.6.16

2 files

0.6.15

2 files

0.6.14

2 files

0.6.13

2 files

0.6.12

2 files

0.6.11

2 files

0.6.10

2 files

0.6.9

2 files

0.6.8

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page