Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement NEWS based API support for realtime NEWS and updates #14

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

vishwamartur
Copy link
Owner

@vishwamartur vishwamartur commented Nov 5, 2024

Related to #4

Add NEWS API support for real-time news and updates.

  • Configuration Changes

    • Add NEWS_API_KEY and NEWS_API_ENDPOINT to .env file.
    • Update config/api_config.py to include news_api_key and news_api_endpoint.
    • Add news_headers method to APIConfig class.
    • Add get_news_endpoint method to APIConfig class.
  • News Data Fetcher

    • Create data/news_data_fetcher.py with NewsDataFetcher class.
    • Add fetch_news_data method to NewsDataFetcher class.
  • Main Integration

    • Import NewsDataFetcher in main.py.
    • Initialize NewsDataFetcher instance with news_api_key and news_api_endpoint.
    • Update process_market_data function to include news_fetcher parameter.
    • Fetch and process news data in process_market_data function.
  • Data Fetcher Updates

    • Import NewsDataFetcher in data/data_fetcher.py.
    • Add news_fetcher attribute to DataFetcher class.
    • Initialize news_fetcher in DataFetcher constructor.
    • Add fetch_and_process_news_data method to DataFetcher class.

Summary by CodeRabbit

  • New Features

    • Integrated News API functionality, allowing users to fetch news data alongside existing market and weather data.
    • Added support for processing news data within the trading bot, enhancing decision-making capabilities.
  • Bug Fixes

    • Improved error handling during news data fetching to ensure robustness.
  • Documentation

    • Updated environment variable requirements to include NEWS_API_KEY and NEWS_API_ENDPOINT.

Related to #4

Add NEWS API support for real-time news and updates.

* **Configuration Changes**
  - Add `NEWS_API_KEY` and `NEWS_API_ENDPOINT` to `.env` file.
  - Update `config/api_config.py` to include `news_api_key` and `news_api_endpoint`.
  - Add `news_headers` method to `APIConfig` class.
  - Add `get_news_endpoint` method to `APIConfig` class.

* **News Data Fetcher**
  - Create `data/news_data_fetcher.py` with `NewsDataFetcher` class.
  - Add `fetch_news_data` method to `NewsDataFetcher` class.

* **Main Integration**
  - Import `NewsDataFetcher` in `main.py`.
  - Initialize `NewsDataFetcher` instance with `news_api_key` and `news_api_endpoint`.
  - Update `process_market_data` function to include `news_fetcher` parameter.
  - Fetch and process news data in `process_market_data` function.

* **Data Fetcher Updates**
  - Import `NewsDataFetcher` in `data/data_fetcher.py`.
  - Add `news_fetcher` attribute to `DataFetcher` class.
  - Initialize `news_fetcher` in `DataFetcher` constructor.
  - Add `fetch_and_process_news_data` method to `DataFetcher` class.
Copy link

coderabbitai bot commented Nov 5, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new functionality to integrate a News API within the existing application. This includes updates to the .env file to store the API key and endpoint for the News API. The APIConfig class has been modified to accommodate these new configurations, while the DataFetcher class has been enhanced to fetch news data asynchronously. A new NewsDataFetcher class has been created to handle the specifics of fetching news articles. Finally, the main.py file has been updated to incorporate the new news data processing into the existing workflow.

Changes

File Change Summary
.env Added NEWS_API_KEY and NEWS_API_ENDPOINT variables.
config/api_config.py Added self.news_api_key, self.news_api_endpoint, news_headers(), and get_news_endpoint() methods in APIConfig class.
data/data_fetcher.py Added self.news_fetcher and async fetch_and_process_news_data(self, topic: str) in DataFetcher class.
data/news_data_fetcher.py Introduced NewsDataFetcher class with methods __init__() and fetch_news_data(topic: str).
main.py Updated to include news_fetcher in process_market_data and on_message, and created an instance of NewsDataFetcher.

Poem

In the garden of code, where data does flow,
A new stream of news begins to grow.
With keys and endpoints, we fetch with delight,
As rabbits hop in, bringing insights so bright.
From market to news, our wisdom expands,
Together we thrive in these digital lands! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vishwamartur vishwamartur merged commit b759073 into main Nov 5, 2024
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant