# Quick Start
Silverback lets you create and deploy your own Python bots that respond to on-chain events.
The Silverback library leverages the [Ape](https://docs.apeworx.io/ape/stable/userguides/quickstart) development framework as well as it's ecosystem of plugins and packages to enable you to develop simple-yet-sophisticated automated applications that can listen and respond to live chain data.
Silverback applications are excellent for use cases that involve continuously monitoring and responding to on-chain events, such as newly confirmed blocks or contract event logs.
Some examples of these types of applications:
- Monitoring new pool creations, and depositing liquidity
- Measuring trading activity of popular pools
- Listening for large swaps to update a telegram group
## Documentation
Read the [development userguide](https://docs.apeworx.io/silverback/stable/userguides/development.html) to learn more how to develop an application.
## Dependencies
- [python3](https://www.python.org/downloads) version 3.8 or greater, python3-dev
## Installation
Silverback relies heavily on the Ape development framework, so it's worth it to familarize yourself with how to install Ape and it's plugins using the [Ape installation userguide](https://docs.apeworx.io/ape/latest/userguides/quickstart#installation).
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install silverback
```
### 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/silverback.git silverback
cd silverback
python3 setup.py install
```
## Quick Usage
Checkout [the example](./example.py) to see how to use the library.
To run your bot against a live network, this SDK includes a simple runner you can use via:
```sh
$ silverback run "example:app" --network :mainnet:alchemy
```
**NOTE**: The example is designed to work with Python 3.9+, and we suggest using 3.11+ for speed.
## Docker Usage
```sh
$ docker run --volume $PWD:/home/harambe/project --volume ~/.tokenlists:/home/harambe/.tokenlists apeworx/silverback:latest run "example:app" --network :mainnet:alchemy
```
## 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/silverback",
"name": "silverback",
"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/de/2b/25954032bf02f88387e5a4bb4a973978bb5b0539d8b5734f325dcf50664a/silverback-0.3.3.tar.gz",
"platform": null,
"description": "# Quick Start\n\nSilverback lets you create and deploy your own Python bots that respond to on-chain events.\nThe Silverback library leverages the [Ape](https://docs.apeworx.io/ape/stable/userguides/quickstart) development framework as well as it's ecosystem of plugins and packages to enable you to develop simple-yet-sophisticated automated applications that can listen and respond to live chain data.\n\nSilverback applications are excellent for use cases that involve continuously monitoring and responding to on-chain events, such as newly confirmed blocks or contract event logs.\n\nSome examples of these types of applications:\n\n- Monitoring new pool creations, and depositing liquidity\n- Measuring trading activity of popular pools\n- Listening for large swaps to update a telegram group\n\n## Documentation\n\nRead the [development userguide](https://docs.apeworx.io/silverback/stable/userguides/development.html) to learn more how to develop an application.\n\n## Dependencies\n\n- [python3](https://www.python.org/downloads) version 3.8 or greater, python3-dev\n\n## Installation\n\nSilverback relies heavily on the Ape development framework, so it's worth it to familarize yourself with how to install Ape and it's plugins using the [Ape installation userguide](https://docs.apeworx.io/ape/latest/userguides/quickstart#installation).\n\n### via `pip`\n\nYou can install the latest release via [`pip`](https://pypi.org/project/pip/):\n\n```bash\npip install silverback\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/silverback.git silverback\ncd silverback\npython3 setup.py install\n```\n\n## Quick Usage\n\nCheckout [the example](./example.py) to see how to use the library.\n\nTo run your bot against a live network, this SDK includes a simple runner you can use via:\n\n```sh\n$ silverback run \"example:app\" --network :mainnet:alchemy\n```\n\n**NOTE**: The example is designed to work with Python 3.9+, and we suggest using 3.11+ for speed.\n\n## Docker Usage\n\n```sh\n$ docker run --volume $PWD:/home/harambe/project --volume ~/.tokenlists:/home/harambe/.tokenlists apeworx/silverback:latest run \"example:app\" --network :mainnet:alchemy\n```\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",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Ape SDK for the Silverback platform",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/silverback"
},
"split_keywords": [
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d1d9a436f292c1ca77276649c23683b058835bcc735e1f25304241eb470eeff",
"md5": "1f19235c8b4a3892410bdc989f66b492",
"sha256": "4ace95d0a20ff23fcecb00b52f5f5d649f67e783ae6cade780dbe5b7956a4a74"
},
"downloads": -1,
"filename": "silverback-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f19235c8b4a3892410bdc989f66b492",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 25689,
"upload_time": "2024-04-27T18:07:04",
"upload_time_iso_8601": "2024-04-27T18:07:04.861008Z",
"url": "https://files.pythonhosted.org/packages/0d/1d/9a436f292c1ca77276649c23683b058835bcc735e1f25304241eb470eeff/silverback-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de2b25954032bf02f88387e5a4bb4a973978bb5b0539d8b5734f325dcf50664a",
"md5": "41158ab0888a973d7a3ab20b44f0f43c",
"sha256": "6b2993f20d853270969d4509fe53ce42c931d0adb0bad61e59f6071c013bf7b9"
},
"downloads": -1,
"filename": "silverback-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "41158ab0888a973d7a3ab20b44f0f43c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 77294,
"upload_time": "2024-04-27T18:07:06",
"upload_time_iso_8601": "2024-04-27T18:07:06.181799Z",
"url": "https://files.pythonhosted.org/packages/de/2b/25954032bf02f88387e5a4bb4a973978bb5b0539d8b5734f325dcf50664a/silverback-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 18:07:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "silverback",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "silverback"
}
JSON
