Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruchernchong/oled-blackmeter
A Telegram bot to measure the percentage of black pixels in OLED wallpapers. It helps users evaluate the true black content of their wallpapers.
https://github.com/ruchernchong/oled-blackmeter
google-cloud-functions pulumi pulumi-gcp python telegram-bot
Last synced: 12 days ago
JSON representation
A Telegram bot to measure the percentage of black pixels in OLED wallpapers. It helps users evaluate the true black content of their wallpapers.
- Host: GitHub
- URL: https://github.com/ruchernchong/oled-blackmeter
- Owner: ruchernchong
- License: mit
- Created: 2024-06-02T05:32:22.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-24T06:02:58.000Z (28 days ago)
- Last Synced: 2025-01-08T18:27:59.865Z (12 days ago)
- Topics: google-cloud-functions, pulumi, pulumi-gcp, python, telegram-bot
- Language: Python
- Homepage: https://t.me/OLEDBlackMeterBot
- Size: 4.91 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# OLED BlackMeter
Link to the Telegram Bot: https://t.me/OLEDBlackMeterBot
## Installation
```bash
# Install the necessary packages
pip install -r requirements.txt
```
## Run in Local Development
```bash
# Setup ngrok
ngrok http 5000 # Flask uses port 5000 by default. You can change this accordingly to your preference
# Copy the .env.example file and replace the values accordingly
cp .env.example .env
# Update your NGROK_STATIC_DOMAIN in .env with the ngrok "Forwarding" URL
NGROK_STATIC_DOMAIN=2655-158-140-141-125.ngrok-free.app # Example
# Update your Telegram Bot Token in your .env
TELEGRAM_BOT_TOKEN=
# Run the server.py
python server.py
```
Once the above is completed, head over to your Telegram Bot that was setup with [@BotFather](https://t.me/BotFather) and
you are done.
## Deploy to Google Cloud Functions
By default, this Telegram bot is already properly setup and you may follow the commands below to deploy to Google Cloud
Functions.
```bash
# Setup a Pulumi Stack (You will need a Pulumi account first)
pulumi stack init
# Update the stack
pulumi up
```
However, if you have intention to use other methods of deployment, you are feel free to do so.
*Do note that the current setup is running in webhook mode rather than polling mode.
## Screenshots
