# Quick Start
Chainstack network provider plugins.
This plugin allows using the Ape framework with Chainstack as a node provider in an easy and integrated way.
Ape is an innovative smart contract development and testing framework.
It is inspired by Brownie, and it has essentially the same syntax.
Still, Ape focuses on a more modular approach, allowing us to build and use external plugins to add functionality.
## Table of contents
- [Ape Chainstack Plugin](#ape-chainstack-plugin)
- [Requirements](#requirements)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Virtual environment](#virtual-environment)
- [Install ape-chainstack via `pip`](#install-ape-chainstack-via-pip)
- [Install ape-chainstack via `setuptools`](#install-ape-chainstack-via-setuptools)
- [Quick Usage](#quick-usage)
- [Development](#development)
- [License](#license)
## Requirements
- Linux or macOS
- Windows Subsystem Linux ([WSL](https://docs.microsoft.com/en-us/windows/wsl/install)) if operating on windows.
### Dependencies
- [python3](https://www.python.org/downloads) version 3.8 or greater
- python3-dev
- MacOS. Should already have the [correct headers if Python is installed with `brew`](https://stackoverflow.com/questions/32578106/how-to-install-python-devel-in-mac-os)
- Linux. Install python3-dev with:
```sh
sudo apt-get install python3-dev
```
> **Note:** Always check the [Ape docs to find the updated requirements](https://docs.apeworx.io/ape/stable/userguides/quickstart.html#prerequisite).
## Installation
Verify the Python version installed:
```sh
Python3 --version
```
### Virtual environment
It is recommended to operate in a virtual environment; you will need to [install Ape](https://github.com/ApeWorX/ape#installation) in the virtual environment if you decide to use one.
Create a virtual environment.
```sh
python3 -m venv /path/to/new/environment
```
> Keep in mind that you can place the virtual environment where you prefer.
Then activate it.
```sh
source /bin/activate
```
### Install ape-chainstack via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install ape-chainstack
```
### Install ape-chainstack via `setuptools`
You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
```bash
git clone https://github.com/ApeWorX/ape-chainstack.git
cd ape-chainstack
python3 setup.py install
```
Verify that the Chainstack plugin was installed correctly with this command:
```bash
ape plugins list
```
It will show a list of all the plugins installed, and Chainstack will be there.
```bash
Installed Plugins:
chainstack <current version number>
```
## Quick Usage
Follow these steps to sign up on Chainstack, deploy a node, and find your endpoint credentials:
1. [Sign up with Chainstack](https://console.chainstack.com/user/account/create).
1. [Deploy a node](https://docs.chainstack.com/platform/join-a-public-network).
1. [View node access and credentials](https://docs.chainstack.com/platform/view-node-access-and-credentials).
> **Note:** At this moment only the Ethereum network is supported.
Create an environment variable with your Chainstack node URL in this format `CHAINSTACK_"NETWORK"_URL=ENDPOINT_URL`; for example:
```sh
export CHAINSTACK_GOERLI_URL=https://nd-11X-26X-16X.p2pify.com/YOUR_API_KEY
```
Use the command `ape networks list` to see the networks available:
```sh
ethereum (default)
├── mainnet
│ ├── geth (default)
│ └── chainstack
├── ropsten
│ ├── geth (default)
│ └── chainstack
├── kovan
│ └── geth (default)
├── rinkeby
│ ├── geth (default)
│ └── chainstack
├── goerli
│ ├── geth (default)
│ └── chainstack
└── local (default)
├── geth
└── test (default)
```
Use the `--network` command to access the console using your node; for example:
```bash
ape console --network ethereum:goerli:chainstack
```
Check the Ape docs to see [how to select a network](https://docs.apeworx.io/ape/stable/userguides/networks.html).
Now you are ready to use Ape to develop and test your smart contract, checkout the [Ape Academy](https://academy.apeworx.io/) for tutorials.
## Development
This project is in development and should be considered a beta.
Things might not be in their final state and breaking changes may occur.
Comments, questions, criticisms and pull requests are welcomed.
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/ape-chainstack",
"name": "ape-chainstack",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "ethereum",
"author": "ApeWorX Ltd.",
"author_email": "admin@apeworx.io",
"download_url": "https://files.pythonhosted.org/packages/d3/30/975e2ed01795ed673863c377bf607643f7a957f7c2afd9f33ed46fa19b81/ape-chainstack-0.7.0a1.tar.gz",
"platform": null,
"description": "# Quick Start\n\nChainstack network provider plugins.\n\nThis plugin allows using the Ape framework with Chainstack as a node provider in an easy and integrated way.\n\nApe is an innovative smart contract development and testing framework.\nIt is inspired by Brownie, and it has essentially the same syntax.\nStill, Ape focuses on a more modular approach, allowing us to build and use external plugins to add functionality.\n\n## Table of contents\n\n- [Ape Chainstack Plugin](#ape-chainstack-plugin)\n - [Requirements](#requirements)\n - [Dependencies](#dependencies)\n - [Installation](#installation)\n - [Virtual environment](#virtual-environment)\n - [Install ape-chainstack via `pip`](#install-ape-chainstack-via-pip)\n - [Install ape-chainstack via `setuptools`](#install-ape-chainstack-via-setuptools)\n - [Quick Usage](#quick-usage)\n - [Development](#development)\n - [License](#license)\n\n## Requirements\n\n- Linux or macOS\n- Windows Subsystem Linux ([WSL](https://docs.microsoft.com/en-us/windows/wsl/install)) if operating on windows.\n\n### Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.8 or greater\n- python3-dev\n\n - MacOS. Should already have the [correct headers if Python is installed with `brew`](https://stackoverflow.com/questions/32578106/how-to-install-python-devel-in-mac-os)\n\n - Linux. Install python3-dev with:\n\n ```sh\n sudo apt-get install python3-dev\n ```\n\n> **Note:** Always check the [Ape docs to find the updated requirements](https://docs.apeworx.io/ape/stable/userguides/quickstart.html#prerequisite).\n\n## Installation\n\nVerify the Python version installed:\n\n```sh\nPython3 --version\n```\n\n### Virtual environment\n\nIt is recommended to operate in a virtual environment; you will need to [install Ape](https://github.com/ApeWorX/ape#installation) in the virtual environment if you decide to use one.\n\nCreate a virtual environment.\n\n```sh\npython3 -m venv /path/to/new/environment\n```\n\n> Keep in mind that you can place the virtual environment where you prefer.\n\nThen activate it.\n\n```sh\nsource /bin/activate\n```\n\n### Install ape-chainstack via `pip`\n\nYou can install the latest release via [`pip`](https://pypi.org/project/pip/):\n\n```bash\npip install ape-chainstack\n```\n\n### Install ape-chainstack via `setuptools`\n\nYou can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:\n\n```bash\ngit clone https://github.com/ApeWorX/ape-chainstack.git\ncd ape-chainstack\npython3 setup.py install\n```\n\nVerify that the Chainstack plugin was installed correctly with this command:\n\n```bash\nape plugins list\n```\n\nIt will show a list of all the plugins installed, and Chainstack will be there.\n\n```bash\nInstalled Plugins:\n chainstack <current version number>\n```\n\n## Quick Usage\n\nFollow these steps to sign up on Chainstack, deploy a node, and find your endpoint credentials:\n\n1. [Sign up with Chainstack](https://console.chainstack.com/user/account/create).\n1. [Deploy a node](https://docs.chainstack.com/platform/join-a-public-network).\n1. [View node access and credentials](https://docs.chainstack.com/platform/view-node-access-and-credentials).\n\n> **Note:** At this moment only the Ethereum network is supported.\n\nCreate an environment variable with your Chainstack node URL in this format `CHAINSTACK_\"NETWORK\"_URL=ENDPOINT_URL`; for example:\n\n```sh\nexport CHAINSTACK_GOERLI_URL=https://nd-11X-26X-16X.p2pify.com/YOUR_API_KEY\n```\n\nUse the command `ape networks list` to see the networks available:\n\n```sh\nethereum (default)\n\u251c\u2500\u2500 mainnet\n\u2502 \u251c\u2500\u2500 geth (default)\n\u2502 \u2514\u2500\u2500 chainstack\n\u251c\u2500\u2500 ropsten\n\u2502 \u251c\u2500\u2500 geth (default)\n\u2502 \u2514\u2500\u2500 chainstack\n\u251c\u2500\u2500 kovan\n\u2502 \u2514\u2500\u2500 geth (default)\n\u251c\u2500\u2500 rinkeby\n\u2502 \u251c\u2500\u2500 geth (default)\n\u2502 \u2514\u2500\u2500 chainstack\n\u251c\u2500\u2500 goerli\n\u2502 \u251c\u2500\u2500 geth (default)\n\u2502 \u2514\u2500\u2500 chainstack\n\u2514\u2500\u2500 local (default)\n \u251c\u2500\u2500 geth\n \u2514\u2500\u2500 test (default)\n```\n\nUse the `--network` command to access the console using your node; for example:\n\n```bash\nape console --network ethereum:goerli:chainstack\n```\n\nCheck the Ape docs to see [how to select a network](https://docs.apeworx.io/ape/stable/userguides/networks.html).\n\nNow you are ready to use Ape to develop and test your smart contract, checkout the [Ape Academy](https://academy.apeworx.io/) for tutorials.\n\n## Development\n\nThis project is in development and should be considered a beta.\nThings might not be in their final state and breaking changes may occur.\nComments, questions, criticisms and pull requests are welcomed.\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ape-chainstack: Ape Ecosystem Plugin for Chainstack",
"version": "0.7.0a1",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-chainstack"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e70bfbbe05a97f4a6f69f10442d63cc049ff9ac0bad25858adc022cbdf7558e2",
"md5": "3529af1fe4ed514126a2dcd6ba3e43e1",
"sha256": "d084d22dc9b13624c72e1f7eaeb063cbd6e5e4cfa7b2496c55cc3f8a35700dde"
},
"downloads": -1,
"filename": "ape_chainstack-0.7.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3529af1fe4ed514126a2dcd6ba3e43e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 10196,
"upload_time": "2023-12-19T03:02:31",
"upload_time_iso_8601": "2023-12-19T03:02:31.808701Z",
"url": "https://files.pythonhosted.org/packages/e7/0b/fbbe05a97f4a6f69f10442d63cc049ff9ac0bad25858adc022cbdf7558e2/ape_chainstack-0.7.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d330975e2ed01795ed673863c377bf607643f7a957f7c2afd9f33ed46fa19b81",
"md5": "64d4e8dab469eaf652251baba1c39ac8",
"sha256": "f77d5ae28b173f0abb200be87752399ab238580ea8668111e2526143efaef6b9"
},
"downloads": -1,
"filename": "ape-chainstack-0.7.0a1.tar.gz",
"has_sig": false,
"md5_digest": "64d4e8dab469eaf652251baba1c39ac8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 16796,
"upload_time": "2023-12-19T03:02:33",
"upload_time_iso_8601": "2023-12-19T03:02:33.567517Z",
"url": "https://files.pythonhosted.org/packages/d3/30/975e2ed01795ed673863c377bf607643f7a957f7c2afd9f33ed46fa19b81/ape-chainstack-0.7.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-19 03:02:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-chainstack",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ape-chainstack"
}
JSON
