Update README.md and DEVELOPMENT_PLAN.md with revised research plan
This commit is contained in:
22
README.md
22
README.md
@@ -1,25 +1,23 @@
|
||||
# YouTube Chat Webhook Listener (Version 2) - gRPC Implementation
|
||||
# YouTube Chat Listener (Version 2) - Sustainable Live Chat Exploration
|
||||
|
||||
This project aims to create a robust, quota-friendly, open-source, and Linux-compatible solution for monitoring YouTube Live Chat by implementing the recommended `liveChatMessages.streamList` gRPC endpoint. This approach will provide an event-driven, server-push model for receiving live chat messages, effectively eliminating the limitations and quota consumption associated with continuous API polling.
|
||||
This project aims to create a robust, quota-friendly, open-source, and Linux-compatible solution for monitoring YouTube Live Chat. Our initial research indicated a gRPC endpoint, but further investigation revealed this is not publicly available. Therefore, this project is now focused on a deeper exploration of alternative, sustainable methods to acquire live chat data without relying on continuous, quota-limited API polling or requesting quota increases.
|
||||
|
||||
## Project Goal
|
||||
|
||||
To build a Python application that leverages the `liveChatMessages.streamList` gRPC endpoint to receive real-time YouTube Live Chat messages, process them, and display them in the terminal with rich formatting. This will ensure a highly efficient and compliant method for sustained live stream monitoring.
|
||||
To identify and, if feasible, implement a sustainable, quota-friendly, compliant, open-source, and Linux-compatible method for receiving real-time YouTube Live Chat messages, processing them, and displaying them in the terminal with rich formatting. This goal explicitly rules out relying on YouTube Data API v3 quota increases.
|
||||
|
||||
## Detailed Implementation Plan
|
||||
## Revised Research & Exploration Plan
|
||||
|
||||
For a detailed breakdown of the implementation steps, please refer to the [DEVELOPMENT_PLAN.md](DEVELOPMENT_PLAN.md) file.
|
||||
For a detailed breakdown of the revised research and exploration steps, please refer to the [DEVELOPMENT_PLAN.md](DEVELOPMENT_PLAN.md) file.
|
||||
|
||||
## Dependencies
|
||||
|
||||
* `grpcio`
|
||||
* `grpcio-tools`
|
||||
* `google-auth-oauthlib`
|
||||
* `google-api-python-client`
|
||||
* `rich`
|
||||
* `google-auth-oauthlib` (for potential initial API calls or authentication research)
|
||||
* `google-api-python-client` (for potential initial API calls or authentication research)
|
||||
* `rich` (for terminal display)
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
* Interactive message sending via gRPC (if supported by the API).
|
||||
* Interactive message sending.
|
||||
* More advanced terminal UI (e.g., `prompt_toolkit` for input).
|
||||
* Web overlay integration.
|
||||
* Web overlay integration.
|
||||
|
||||
Reference in New Issue
Block a user