# Quick Start
The following blockchain explorers are supported in this plugin:
- [Base](https://base.blockscout.com/) for Base networks.
- [Ethereum](https://eth.blockscout.com/) for Ethereum networks.
- [Gnosis](https://gnosis.blockscout.com/) for Gnosis networks.
- [Optimism](https://optimism.blockscout.com/) for Optimism networks.
- [Polygon](https://polygon.blockscout.com/) for Polygon POS networks.
## Dependencies
- [python3](https://www.python.org/downloads) version 3.8 up to 3.11.
## Installation
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install ape-blockscout
```
### 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-blockscout.git
cd ape-blockscout
python3 setup.py install
```
## Quick Usage
## Set up the environment
Specify API keys as environment variables. You could put them in your shell's config like `~/.profile`
or use a tool like [direnv](https://direnv.net/) and store them locally in `.envrc`.
You can also specify multiple comma-separated keys, a random key will be chosen for each request.
This could be useful if you hit API rate limits.
You can obtain an API key by registering with Blockscout and visiting [this page](https://docs.blockscout.com/for-users/my-account/api-keys).
```bash
export BASE_BLOCKSCOUT_API_KEY=SAMPLE_KEY
export ETH_BLOCKSCOUT_API_KEY=SAMPLE_KEY
export GNOSIS_BLOCKSCOUT_API_KEY=SAMPLE_KEY
export OPTIMISM_BLOCKSCOUT_API_KEY=SAMPLE_KEY
export POLYGON_BLOCKSCOUT_API_KEY=SAMPLE_KEY
```
## Development
Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.
Comments, questions, criticisms and pull requests are welcomed.
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/ape-blockscout",
"name": "ape-blockscout",
"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/61/58/040e7116be2850c867d83da60a83cff2952fb0e1511476f795e407529df9/ape-blockscout-0.7.1.tar.gz",
"platform": null,
"description": "# Quick Start\n\nThe following blockchain explorers are supported in this plugin:\n\n- [Base](https://base.blockscout.com/) for Base networks.\n- [Ethereum](https://eth.blockscout.com/) for Ethereum networks.\n- [Gnosis](https://gnosis.blockscout.com/) for Gnosis networks.\n- [Optimism](https://optimism.blockscout.com/) for Optimism networks.\n- [Polygon](https://polygon.blockscout.com/) for Polygon POS networks.\n\n## Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.8 up to 3.11.\n\n## Installation\n\n### via `pip`\n\nYou can install the latest release via [`pip`](https://pypi.org/project/pip/):\n\n```bash\npip install ape-blockscout\n```\n\n### 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-blockscout.git\ncd ape-blockscout\npython3 setup.py install\n```\n\n## Quick Usage\n\n## Set up the environment\n\nSpecify API keys as environment variables. You could put them in your shell's config like `~/.profile`\nor use a tool like [direnv](https://direnv.net/) and store them locally in `.envrc`.\n\nYou can also specify multiple comma-separated keys, a random key will be chosen for each request.\nThis could be useful if you hit API rate limits.\n\nYou can obtain an API key by registering with Blockscout and visiting [this page](https://docs.blockscout.com/for-users/my-account/api-keys).\n\n```bash\nexport BASE_BLOCKSCOUT_API_KEY=SAMPLE_KEY\nexport ETH_BLOCKSCOUT_API_KEY=SAMPLE_KEY\nexport GNOSIS_BLOCKSCOUT_API_KEY=SAMPLE_KEY\nexport OPTIMISM_BLOCKSCOUT_API_KEY=SAMPLE_KEY\nexport POLYGON_BLOCKSCOUT_API_KEY=SAMPLE_KEY\n```\n\n## Development\n\nPlease see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project.\nComments, questions, criticisms and pull requests are welcomed.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ape-blockscout: Blockscout Explorer Plugin",
"version": "0.7.1",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/ape-blockscout"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b5150334aa657b73966cb886fad956ed9f15c70469e3b73d4bb275f8dfa9ebd",
"md5": "6b219c193973dd7626b0af60fa82369f",
"sha256": "d209ae4d89818aeb5fd6e7fb36edfa5638df0157ed24dd3c64aad42305d8970f"
},
"downloads": -1,
"filename": "ape_blockscout-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b219c193973dd7626b0af60fa82369f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 14299,
"upload_time": "2024-03-26T21:43:59",
"upload_time_iso_8601": "2024-03-26T21:43:59.095419Z",
"url": "https://files.pythonhosted.org/packages/8b/51/50334aa657b73966cb886fad956ed9f15c70469e3b73d4bb275f8dfa9ebd/ape_blockscout-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6158040e7116be2850c867d83da60a83cff2952fb0e1511476f795e407529df9",
"md5": "3be102638a44e36ac4ac419a461c47a1",
"sha256": "d5f0ad71517cf3bf89d3da6b1c139da79f210e9036739d67178720330f14362e"
},
"downloads": -1,
"filename": "ape-blockscout-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "3be102638a44e36ac4ac419a461c47a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 79656,
"upload_time": "2024-03-26T21:44:01",
"upload_time_iso_8601": "2024-03-26T21:44:01.074018Z",
"url": "https://files.pythonhosted.org/packages/61/58/040e7116be2850c867d83da60a83cff2952fb0e1511476f795e407529df9/ape-blockscout-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 21:44:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "ape-blockscout",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ape-blockscout"
}
JSON
