{"id":14970706,"url":"https://github.com/apeworx/ape","last_synced_at":"2026-02-16T23:41:27.381Z","repository":{"id":37034795,"uuid":"326840499","full_name":"ApeWorX/ape","owner":"ApeWorX","description":"The smart contract development tool for Pythonistas, Data Scientists, and Security Professionals","archived":false,"fork":false,"pushed_at":"2024-10-27T01:53:03.000Z","size":1569687,"stargazers_count":885,"open_issues_count":147,"forks_count":132,"subscribers_count":16,"default_branch":"main","last_synced_at":"2024-10-29T14:51:40.173Z","etag":null,"topics":["ape","apeworx","brownie","defi","developer-tools","ethereum","framework","nft","python","smart-contracts","solidity","vyper","web3"],"latest_commit_sha":null,"homepage":"https://apeworx.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ApeWorX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"ApeWorX"}},"created_at":"2021-01-05T00:18:22.000Z","updated_at":"2024-10-27T09:04:45.000Z","dependencies_parsed_at":"2022-07-11T05:45:57.890Z","dependency_job_id":"3713e79b-6485-49ab-8a56-c37046843701","html_url":"https://github.com/ApeWorX/ape","commit_stats":{"total_commits":1408,"total_committers":67,"mean_commits":21.01492537313433,"dds":0.4850852272727273,"last_synced_commit":"13ea95253a75d9576d5f89f6378254abda200e9e"},"previous_names":[],"tags_count":151,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApeWorX%2Fape","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApeWorX%2Fape/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApeWorX%2Fape/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApeWorX%2Fape/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ApeWorX","download_url":"https://codeload.github.com/ApeWorX/ape/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248154515,"owners_count":21056539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ape","apeworx","brownie","defi","developer-tools","ethereum","framework","nft","python","smart-contracts","solidity","vyper","web3"],"created_at":"2024-09-24T13:44:01.004Z","updated_at":"2026-01-16T15:28:13.697Z","avatar_url":"https://github.com/ApeWorX.png","language":"Python","funding_links":["https://github.com/sponsors/ApeWorX"],"categories":[],"sub_categories":[],"readme":"[![Pypi.org][pypi-badge]][pypi-url]\n[![Apache licensed][license-badge]][license-url]\n[![Build Status][actions-badge]][actions-url]\n[![Contributing][contributing-badge]][contributing-url]\n[![Discord chat][discord-badge]][discord-url]\n[![Twitter][twitter-badge]][twitter-url]\n[![DeepWiki][deepwiki-badge]][deepwiki-url]\n\n# Overview\n\n[Ape Framework](https://apeworx.io/framework/) is an easy-to-use Web3 development tool.\nUsers can compile, test, and interact with smart contracts all in one command line session.\nWith our [modular plugin system](#plugin-system), Ape supports multiple contract languages and chains.\n\nApe is built by [ApeWorX LTD](https://www.apeworx.io/).\n\nJoin our [ApeWorX Discord server][discord-url] to stay up to date on new releases, plugins, and tutorials.\n\nIf you want to get started now, see the [Quickstart](#quickstart) section.\n\n## Documentation\n\nRead our [technical documentation](https://docs.apeworx.io/ape/stable/) to get a deeper understanding of our open source Framework.\n\nRead our [academic platform](https://academy.apeworx.io/) which will help you master Ape Framework with tutorials and challenges.\n\n## Prerequisite\n\nIn the latest release, Ape requires:\n\n- Linux or macOS\n- Python 3.10 up to 3.13\n- **Windows**: Install Windows Subsystem Linux [(WSL)](https://docs.microsoft.com/en-us/windows/wsl/install)\n\nCheck your python version in a terminal with `python3 --version`.\n\n## Installation\n\nThere are three ways to install ape: `pipx`, `pip`, or `Docker`.\n\n### Considerations for Installing\n\n- If using `pip`, we advise using the most up-to-date version of `pip` to increase the chance of a successful installation.\n\n  - See issue https://github.com/ApeWorX/ape/issues/1558.\n  - To upgrade `pip` from the command line, run: `pip install --upgrade pip`.\n\n- We advise installing in a [virtualenv](https://pypi.org/project/virtualenv/) or [venv](https://docs.python.org/3/library/venv.html) to avoid interfering with *OS-level site packages*.\n\n- We advise installing **`ape`** with recommended plugins `pip install eth-ape'[recommended-plugins]'`.\n\n- We advise for **macOS** users to install virtual env via [homebrew](https://formulae.brew.sh/formula/virtualenv).\n\n### Installing with `pipx` or `pip`\n\n1. Install `pipx` via their [installation instructions](https://pypa.github.io/pipx/) or `pip` via their [installation instructions](https://pip.pypa.io/en/stable/cli/pip_install/).\n\n2. Install **`ape`** via `pipx install eth-ape` or `pip install eth-ape`.\n\n### Installing with `docker`\n\nApe can also run in a docker container.\n\nYou can pull our images from [ghcr](https://ghcr.io/apeworx/ape).\nThis image is built using our `recommended-plugins` extra, so it is a great starting point for running ape in a containerized environment.\n\nWe also have a `slim` docker image that is built without any installed plugins.\nThis image is meant for production support and must be further configured if any plugins are in use.\n\nYou can pull the image:\n\n```bash\n$ docker pull ghcr.io/apeworx/ape:latest  # installs with recommended-plugins\n```\n\nor pull the slim if you have specific needs that you'd like to build from:\n\n```bash\n$ docker pull ghcr.io/apeworx/ape:latest-slim  # installs ape with required packages\n```\n\nor build the image locally from source:\n\n```bash\n$ docker build -t ape:latest-slim -f Dockerfile.slim .\n$ docker build -t ape:latest .\n```\n\nAn example of running a command from the container would be:\n\n```bash\ndocker run \\\n  --volume $HOME/.ape:/home/harambe/.ape \\\n  --volume $HOME/.vvm:/home/harambe/.vvm \\\n  --volume $HOME/.solcx:/home/harambe/.solcx \\\n  --volume $PWD:/home/harambe/project \\\n  apeworx/ape compile\n```\n\n\u003e **Note:**\n\u003e The above command requires the full install which includes `recommended-plugins` installation extra.\n\n## Quickstart\n\nAfter you have installed Ape, run `ape --version` to verify the installation was successful.\n\nYou can interact with Ape using the [command line](https://docs.apeworx.io/ape/stable/userguides/clis.html) or the [Ape console](https://docs.apeworx.io/ape/stable/userguides/console.html).\n\nSee the following user-guides for more in-depth tutorials:\n\n- [Accounts][accounts-guide]\n- [Networks][networks-guide]\n- [Projects][projects-guide]\n- [Compiling][compile-guide]\n- [Testing][testing-guide]\n- [Console][console-guide]\n- [Scripting][scripting-guide]\n- [Logging][logging-guide]\n\n## Plugin System\n\nApe's modular plugin system allows users to have an interoperable experience with Web3.\n\n- Learn about **installing** plugins from following this [installing user guide](https://docs.apeworx.io/ape/stable/userguides/installing_plugins.html).\n\n- Learn more about **developing** your own plugins from this [developing user guide](https://docs.apeworx.io/ape/stable/userguides/developing_plugins.html).\n\n```{note}\nIf a plugin does not originate from the [ApeWorX GitHub Organization](https://github.com/ApeWorX?q=ape\u0026type=all), you will get a warning about installing 3rd-party plugins.\nInstall 3rd party plugins at your own risk.\n```\n\n[accounts-guide]: https://docs.apeworx.io/ape/stable/userguides/accounts.html\n[actions-badge]: https://github.com/ApeWorX/ape/actions/workflows/test.yaml/badge.svg\n[actions-url]: https://github.com/ApeWorX/ape/actions?query=branch%3Amain+event%3Apush\n[compile-guide]: https://docs.apeworx.io/ape/stable/userguides/compile.html\n[console-guide]: https://docs.apeworx.io/ape/stable/userguides/console.html\n[contributing-badge]: https://img.shields.io/badge/CONTRIBUTING-guidelines-brightgreen?style=flat-square\n[contributing-url]: https://github.com/ApeWorX/ape?tab=contributing-ov-file\n[deepwiki-badge]: https://deepwiki.com/badge.svg\n[deepwiki-url]: https://deepwiki.com/ApeWorX/ape\n[discord-badge]: https://img.shields.io/discord/922917176040640612.svg?logo=discord\u0026style=flat-square\n[discord-url]: https://discord.gg/apeworx\n[license-badge]: https://img.shields.io/github/license/ApeWorX/ape?color=blue\n[license-url]: https://github.com/ApeWorX/ape?tab=License-1-ov-file\n[logging-guide]: https://docs.apeworx.io/ape/stable/userguides/logging.html\n[networks-guide]: https://docs.apeworx.io/ape/stable/userguides/networks.html\n[projects-guide]: https://docs.apeworx.io/ape/stable/userguides/projects.html\n[pypi-badge]: https://img.shields.io/pypi/dm/eth-ape?label=pypi.org\n[pypi-url]: https://pypi.org/project/eth-ape/\n[scripting-guide]: https://docs.apeworx.io/ape/stable/userguides/scripts.html\n[testing-guide]: https://docs.apeworx.io/ape/stable/userguides/testing.html\n[twitter-badge]: https://img.shields.io/twitter/follow/ApeFramework\n[twitter-url]: https://twitter.com/ApeFramework\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapeworx%2Fape","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapeworx%2Fape","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapeworx%2Fape/lists"}