[![Pypi.org][pypi-badge]][pypi-url]
[![Apache licensed][licence-badge]][licence-url]
[![Build Status][actions-badge]][actions-url]
[![Discord chat][discord-badge]][discord-url]
[![Twitter][twitter-badge]][twitter-url]
# Overview
[Ape Framework](https://apeworx.io/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](#plugin-system), Ape supports multiple contract languages and chains.
Ape is built by [ApeWorX LTD](https://www.apeworx.io/).
Join our [ApeWorX Discord server][discord-url] to stay up to date on new releases, plugins, and tutorials.
If you want to get started now, see the [Quickstart](#quickstart) section.
## Documentation
Read our [technical documentation](https://docs.apeworx.io/ape/stable/) to get a deeper understanding of our open source Framework.
Read our [academic platform](https://academy.apeworx.io/) will help you master Ape Framework with tutorials and challenges.
## Prerequisite
In the latest release, Ape requires:
- Linux or macOS
- Python 3.8 up to 3.11
- **Windows**: Install Windows Subsystem Linux [(WSL)](https://docs.microsoft.com/en-us/windows/wsl/install)
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.
- See issue https://github.com/ApeWorX/ape/issues/1558.
- To upgrade `pip` from the command line, run: `pip install --upgrade pip`.
- 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*.
- We advise installing **`ape`** with recommended plugins `pip install eth-ape'[recommended-plugins]'`.
- We advise for **macOS** users to install virtual env via [homebrew](https://formulae.brew.sh/formula/virtualenv).
### Installing with `pipx` or `pip`
1. 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/).
2. Install **`ape`** via `pipx install eth-ape` or `pip install eth-ape`.
### Installing with `docker`
Ape can also run in a docker container.
Please visit our [Dockerhub](https://hub.docker.com/repository/docker/apeworx/ape) for more details on using Ape with Docker.
```bash
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
```
## Quickstart
After you have installed Ape, run `ape --version` to verify the installation was successful.
Interact with Ape using either the [CLI](https://docs.apeworx.io/ape/latest/index.html) or [Python code](https://docs.apeworx.io/ape/latest/index.html).
See the following user-guides for more in-depth tutorials:
- [Accounts][accounts-guide]
- [Networks][networks-guide]
- [Projects][projects-guide]
- [Compiling][compile-guide]
- [Testing][testing-guide]
- [Console][console-guide]
- [Scripting][scripting-guide]
- [Logging][logging-guide]
## Plugin System
Ape's modular plugin system allows users to have an interoperable experience with Web3.
- Learn about **installing** plugins from following this [installing user guide](https://docs.apeworx.io/ape/stable/userguides/installing_plugins.html).
- Learn more about **developing** your own plugins from this [developing user guide](https://docs.apeworx.io/ape/stable/userguides/developing_plugins.html).
**NOTE**: 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.
[accounts-guide]: https://docs.apeworx.io/ape/stable/userguides/accounts.html
[actions-badge]: https://github.com/ApeWorX/ape/actions/workflows/test.yaml/badge.svg
[actions-url]: https://github.com/ApeWorX/ape/actions?query=branch%3Amain+event%3Apush
[compile-guide]: https://docs.apeworx.io/ape/stable/userguides/compile.html
[console-guide]: https://docs.apeworx.io/ape/stable/userguides/console.html
[discord-badge]: https://img.shields.io/discord/922917176040640612.svg?logo=discord&style=flat-square
[discord-url]: https://discord.gg/apeworx
[licence-badge]: https://img.shields.io/github/license/ApeWorX/ape?color=blue
[licence-url]: https://github.com/ApeWorX/ape/blob/main/LICENSE
[logging-guide]: https://docs.apeworx.io/ape/stable/userguides/logging.html
[networks-guide]: https://docs.apeworx.io/ape/stable/userguides/networks.html
[projects-guide]: https://docs.apeworx.io/ape/stable/userguides/projects.html
[pypi-badge]: https://img.shields.io/pypi/dm/eth-ape?label=pypi.org
[pypi-url]: https://pypi.org/project/eth-ape/
[scripting-guide]: https://docs.apeworx.io/ape/stable/userguides/scripts.html
[testing-guide]: https://docs.apeworx.io/ape/stable/userguides/testing.html
[twitter-badge]: https://img.shields.io/twitter/follow/ApeFramework
[twitter-url]: https://twitter.com/ApeFramework
Raw data
{
"_id": null,
"home_page": "https://apeworx.io",
"name": "eth-ape",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum",
"author": "ApeWorX Ltd.",
"author_email": "admin@apeworx.io",
"download_url": "https://files.pythonhosted.org/packages/b2/9e/f9a828a7ae15e3d98f4ff575abd49eec1ed3cfb50148e0fb62c28faae22c/eth-ape-0.7.16.tar.gz",
"platform": null,
"description": "[![Pypi.org][pypi-badge]][pypi-url]\n[![Apache licensed][licence-badge]][licence-url]\n[![Build Status][actions-badge]][actions-url]\n[![Discord chat][discord-badge]][discord-url]\n[![Twitter][twitter-badge]][twitter-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/) 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.8 up to 3.11\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\nPlease visit our [Dockerhub](https://hub.docker.com/repository/docker/apeworx/ape) for more details on using Ape with Docker.\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## Quickstart\n\nAfter you have installed Ape, run `ape --version` to verify the installation was successful.\n\nInteract with Ape using either the [CLI](https://docs.apeworx.io/ape/latest/index.html) or [Python code](https://docs.apeworx.io/ape/latest/index.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**: 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.\nInstall 3rd party plugins at your own risk.\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[discord-badge]: https://img.shields.io/discord/922917176040640612.svg?logo=discord&style=flat-square\n[discord-url]: https://discord.gg/apeworx\n[licence-badge]: https://img.shields.io/github/license/ApeWorX/ape?color=blue\n[licence-url]: https://github.com/ApeWorX/ape/blob/main/LICENSE\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",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Ape Ethereum Framework",
"version": "0.7.16",
"project_urls": {
"Documentation": "https://docs.apeworx.io/ape/",
"Funding": "https://gitcoin.co/grants/5958/ape-maintenance-fund",
"Homepage": "https://apeworx.io",
"Source": "https://github.com/ApeWorX/ape",
"Tracker": "https://github.com/ApeWorX/ape/issues",
"Twitter": "https://twitter.com/ApeFramework"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8fac00f39f93fd4e77423bdab417944cb315ed1cc51315e8da3565ffbee6f3af",
"md5": "38c71c1da0b1395c63dcaf6289896f32",
"sha256": "4511bcebb93ddf337dcd68e179cd0fef9f5efafbba64c5f52beb7a789e545425"
},
"downloads": -1,
"filename": "eth_ape-0.7.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38c71c1da0b1395c63dcaf6289896f32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 324875,
"upload_time": "2024-04-16T21:33:24",
"upload_time_iso_8601": "2024-04-16T21:33:24.556834Z",
"url": "https://files.pythonhosted.org/packages/8f/ac/00f39f93fd4e77423bdab417944cb315ed1cc51315e8da3565ffbee6f3af/eth_ape-0.7.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b29ef9a828a7ae15e3d98f4ff575abd49eec1ed3cfb50148e0fb62c28faae22c",
"md5": "5635e9a0af405624fe18de9d24c8b660",
"sha256": "b30e4d1964f765e375f1feb443b41a7bdeb24369d17a9c3c3e78891189991eb3"
},
"downloads": -1,
"filename": "eth-ape-0.7.16.tar.gz",
"has_sig": false,
"md5_digest": "5635e9a0af405624fe18de9d24c8b660",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 1284030,
"upload_time": "2024-04-16T21:33:27",
"upload_time_iso_8601": "2024-04-16T21:33:27.721011Z",
"url": "https://files.pythonhosted.org/packages/b2/9e/f9a828a7ae15e3d98f4ff575abd49eec1ed3cfb50148e0fb62c28faae22c/eth-ape-0.7.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 21:33:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "eth-ape"
}
JSON
