Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aorumbayev/algoping
📣 A tiny cron job that issues a tweet with Algorand Block proposal stats on daily basis
https://github.com/aorumbayev/algoping
List: algoping
algoexplorer algonode algorand algorand-blockchain algorand-dev awesome-list awesomealgo health-check
Last synced: 3 months ago
JSON representation
📣 A tiny cron job that issues a tweet with Algorand Block proposal stats on daily basis
- Host: GitHub
- URL: https://github.com/aorumbayev/algoping
- Owner: aorumbayev
- License: mit
- Created: 2022-10-13T20:45:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-15T15:24:44.000Z (12 months ago)
- Last Synced: 2024-04-09T07:11:20.563Z (3 months ago)
- Topics: algoexplorer, algonode, algorand, algorand-blockchain, algorand-dev, awesome-list, awesomealgo, health-check
- Language: Python
- Homepage: https://algoping.betteruptime.com
- Size: 69.3 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-algorand - AlgoPing - A tiny cron job that issues a [tweet](https://twitter.com/algoping) if public Algorand Nodes (AlgoExplorer, AlgoNode and etc) are not healthy. (Community Resources / Projects)
README
📣 I am a free and open source health monitoring bot for Algorand Developers that issues a tweet with statistics on number of block proposals and other useful daily information.
## About
### What is AlgoPing?
**1. Analytics Tweet Bot**:
AlgoPing is a daily cron triggered bot that uses [BitQuery](https://bitquery.io/) GraphQL API to fetch daily stats on total amount of block proposals and info on proposers. It then uses [Tweepy](https://www.tweepy.org/) to post a tweet with the stats on daily basis to [@algoping](https://twitter.com/algoping) Twitter account.
**2. Health Monitoring Status Page**:
Additionally, AlgoPing uses [BetterUptime](https://betteruptime.com/) to monitor the status of Node and Indexer servers provided by [AlgoNode](https://algonode.io/) and [AlgoExplorer](https://algoexplorer.io/) respectively. Please note the status page is not affiliated with AlgoNode or AlgoExplorer, for official status refer to their respective websites and communication channels. The aim is to simply provide a free unnoficial status page for the Algorand community that aggregates different Node and Indexer Providers.
> Please note there are not source codes for health monitoring as AlgoPing relies on a free tier on a third party provider named [BetterUptime](https://betteruptime.com/). If you are interested in setting up your own health monitoring status page, please refer to [BetterUptime](https://betteruptime.com/) documentation.
## Prerequisites
- [python 3.9.x](https://www.python.org/)
- [poetry](https://python-poetry.org/)
- [pre-commit](https://pre-commit.com/)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/aorumbayev/algoping.git && cd algoping
```
2. Install dependencies:
```bash
poetry install
```
3. Install pre-commit hooks:
```bash
pre-commit install
```
4. Done 🎉
## Usage
Create twitter app and get your credentials. The following environment variables are required by [`tweepy`](https://www.tweepy.org/):
- `BITQUERY_API_KEY` - Specify Bitquery GraphQL API key to get daily stats on total amount of block proposals and info on proposers.
Once you have your credentials, you can run the bot locally with:
```bash
PYTHONPATH="." poetry run python src/analytics.py
```
## Contributing
Contributions are welcome if you want to improve existing setup of the bot that is currently reporting to [AlgoPing](https://twitter.com/algoping) twitter account.
Otherwise, feel free to clone it and tweak it for your needs to run the bot on your own twitter account.