Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mihaiii/timestampbuddy
A bot that provides Youtube vid chapters on Twitter (a.k.a. X )
https://github.com/mihaiii/timestampbuddy
bot supabase twitter-api
Last synced: 25 days ago
JSON representation
A bot that provides Youtube vid chapters on Twitter (a.k.a. X )
- Host: GitHub
- URL: https://github.com/mihaiii/timestampbuddy
- Owner: Mihaiii
- License: mit
- Created: 2024-12-19T09:40:30.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-04T10:50:06.000Z (about 1 month ago)
- Last Synced: 2025-01-12T21:12:49.755Z (25 days ago)
- Topics: bot, supabase, twitter-api
- Language: Python
- Homepage:
- Size: 90.8 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **TimeStampBuddy**
Tag [**@TimeStampBuddy**](https://x.com/timestampbuddy) on X (formerly Twitter) with the link to a YouTube video, and it will provide timestamps.
---
## **Cost to Run**
Gemini is free.
HF Space is free.
Supabase is free.
Twitter API is free.
**The cost to run this bot solution is $0**.
## **How to Run**
Install deps:
```bash
pip install -r requirements.txt
```
The main run command is:
```bash
python cron_processor.py
```
### **Environment Setup**
Before running it locally, configure the environment variables:
Create a `.env` file in the **TimeStampBuddy** folder/directory and populate it with values for the following keys:
```
COLLECT_CRON_INTERVAL_SEC = 900
PROCESSOR_IDLE_INTERVAL_SEC = 300
PROCESSOR_ACTIVE_INTERVAL_SEC = 20
MAX_PARALLEL_MESSAGES = 1
X_CONSUMER_KEY = ""
X_CONSUMER_SECRET = ""
X_ACCESS_TOKEN = ""
X_ACCESS_TOKEN_SECRET = ""
X_USERID = ""
SUPABASE_URL = ""
SUPABASE_KEY = ""
GEMINI_MODEL = "gemini-2.0-flash-exp"
GEMINI_API_KEY = ""
YT_TRANSCRIPT_PROXY = ""
```
### **Key Descriptions**
- **COLLECT_CRON_INTERVAL_SEC** – The interval (in seconds) for calling X (Twitter) to gather the latest messages mentioning the bot user (e.g., TimeStampBuddy).
> *Note: Be mindful of Twitter's rate limits:* [X API Rate Limits](https://developer.x.com/en/docs/x-api/rate-limits).
- **PROCESSOR_IDLE_INTERVAL_SEC** – The wait time (in seconds) for the message processor (the service that fetches timestamps based on Twitter messages) when no messages are available to process.
- **PROCESSOR_ACTIVE_INTERVAL_SEC** – The wait time (in seconds) for the message processor (the service that fetches timestamps based on Twitter messages) when messages are available to process. Note that the interval applies between batches of messages, where each batch can contain a maximum number of messages equal to the value of MAX_PARALLEL_MESSAGES.
> *Note: Be mindful of Gemini's rate limits:* [Gemini API Rate Limit](https://ai.google.dev/pricing).
- **MAX_PARALLEL_MESSAGES** – The maximum number of messages that can be processed simultaneously.
- **X_CONSUMER_KEY, X_CONSUMER_SECRET, X_ACCESS_TOKEN, X_ACCESS_TOKEN_SECRET** – These values are provided when you create a [Developer account on X (Twitter)](https://developer.x.com/en).
- **X_USERID** – The bot user's ID. Refer to: [Get User ID](https://developer.x.com/en/docs/x-api/users/lookup/api-reference/get-users-id).
- **SUPABASE_URL, SUPABASE_KEY** – These values are available after setting up a [Supabase account](https://supabase.com/).
- **GEMINI_MODEL** – The name of the Gemini model used to generate timestamps based on video transcripts.
- **GEMINI_API_KEY** – Obtain this key from [Google AI Studio](https://aistudio.google.com/library) → "Get API Key".
- **YT_TRANSCRIPT_PROXY** – The proxy URL if the service is hosted in the cloud. Leave it empty if you don't want to use a proxy. Refer to this [GitHub Issue](https://github.com/jdepoix/youtube-transcript-api/issues/303) for more details.
## **Hosting**
The service behind the [@TimeStampBuddy account on X](https://x.com/timestampbuddy) is hosted for free on a Huggingface Space.
The source files can be inspected here: https://huggingface.co/spaces/Mihaiii/TimeStampBuddy/tree/main .