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

Add Date Filtering and Character Merging to Twitter Scraper #6

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

clydedevv
Copy link

@clydedevv clydedevv commented Feb 4, 2025

Summary

This PR adds two key enhancements to the Twitter scraper pipeline:

Date Range Filtering

Users can specify --start-date and--end-dateto only collect tweets within a given time window.

Character Merging

– Allows merging tweets from multiple accounts into a single “character,” with options to filter retweets, sort by engagement, and more.

These changes unify the new functionality into the existing pipeline and preserve backward compatibility.

Changes

src/twitter/TwitterPipeline.js

  • Added support for command-line date arguments (--start-date / --end-date).
  • Enhanced fallback login flow for rate-limit and login failures.
  • Extended the pipeline’s analytics, including content type breakdown and engagement stats.

src/twitter/merge_characters.js

  • Provides utilities for merging tweets across different accounts.
  • Generates combined stats (engagement totals, date range) and outputs JSON + fine-tuning files.
  • src/virtuals/GenerateMergedCharacter.js
  • Creates a new “character” from multiple source accounts.
  • Saves merged tweets to pipeline//... with analytics and optional date filtering.
  • package.json

General

  • Bumped version number and updated scripts.
  • Ensured dependencies align (removed commander if it was no longer needed, etc.).
  • README.md
  • Documented how to run the scraper with date filtering and how to merge characters.

Testing

Local Tests

  • Ran npm run twitter -- <username> --start-date 2024-10-01 --end-date 2025-01-30 to confirm date filtering.
  • Verified fallback login flow still works if credentials are invalid or if rate limits occur.
  • Confirmed correct output in pipeline//... for the new date-limited tweets.

Merging Characters

  • Used npm run merge_characters (or equivalent script) to merge multiple accounts.

  • Checked that merge_stats.json and merged_tweets.json were correctly generated.

  • No Breaking Changes

  • Existing usage (without date arguments) still collects full tweet history.

  • If fallback isn’t triggered, primary flow remains the same.

Additional Context

  • These changes build on the commits from last week’s date-filter update (see commit bb95cba).
  • Should fix any issues with partial collection or older commits not merging properly.
  • Thank you for reviewing this PR. Please let me know if there’s anything else I can clarify or adjust!

- Add date filtering for tweet collection
- Add character merging capability
- Add merge-characters npm script
- Update README with new features
- Add GenerateMergedCharacter.js for merged Virtuals character cards
- Update TwitterPipeline.js with merge functionality
- Add generate-merged-virtuals script to package.json
- Update README with merged character generation docs
Copy link

coderabbitai bot commented Feb 4, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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