Repository files navigation

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 ourmodular plugin system, Ape supports multiple contract languages and chains.

Ape is built byApeWorX LTD.

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

If you want to get started now, see theQuickstart section.

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

Read ouracademic platform which will help you master Ape Framework with tutorials and challenges.

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 withpython3 --version.

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

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

  • See issue#1558.
  • To upgradepip from the command line, run:pip install --upgrade pip.

• We advise installing in avirtualenv orvenv to avoid interfering withOS-level site packages.

• We advise installingape with recommended pluginspip install eth-ape'[recommended-plugins]'.

• We advise formacOS users to install virtual env viahomebrew.

1. Installpipx via theirinstallation instructions orpip via theirinstallation instructions.

2. Installape viapipx install eth-ape orpip install eth-ape.

Ape can also run in a docker container.

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

We also have aslim 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 includesrecommended-plugins installation extra.

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

You can interact with Ape using thecommand line or theApe console.

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

• Accounts
• Networks
• Projects
• Compiling
• Testing
• Console
• Scripting
• Logging

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

• Learn aboutinstalling plugins from following thisinstalling user guide.

• Learn more aboutdeveloping your own plugins from thisdeveloping user guide.

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.