feat: Upload a sample photo via the client. Validate successful posting to Twitter.

[kwannz]

Relates to

No issue linked (ensure to link related issues or tickets in future PRs).
Risks
Risk Level: Medium
Potential Risks: Misconfiguration of environment variables could cause API authentication failure.
Affected Areas: Twitter functionality, including posting photos, retweets, and likes.
Background
What does this PR do?
This PR adds functionality for a Twitter client, including:

Support for posting photos to Twitter.
Automatic retweets and likes based on keywords.
API authentication integration.
Configuration documentation.
Templates for environment variables.
Character file configuration for Twitter client.
What kind of change is this?
Feature: Non-breaking changes that add functionality.
Documentation changes needed?
Status: Documentation changes are required.
Actions Taken: Documentation for configuration and environment variables has been updated accordingly.
Testing
Where should a reviewer start?
Verify the Twitter client configuration documentation.
Test the environment variable templates.
Detailed testing steps
API Authentication Test:

Initialize the client with the provided API keys and tokens.
Confirm successful login.
Photo Posting Test:

Upload a sample photo via the client.
Validate successful posting to Twitter.
Keyword-Based Interaction:

Set keywords for retweets and likes in the configuration.
Observe and verify automatic actions based on these keywords.
Character Configuration Validation:

Load a sample character configuration file.
Verify seamless integration with the Twitter client.
Deploy Notes
No special deployment instructions; standard deployment process suffices.
Ensure all environment variables are set correctly before deployment.
Additional Information
Discord username
N/A (Please add your Discord username if you have one).

[kwannz]

Twitter Client Configuration Guide Twitter Client Configuration Guide
Basic Setup Basic Setup
Environment Variables Environment Variables
Copy .env.example to .env
Copy .env.example to .env
Required Credentials Required Credentials
TWITTER_USERNAME=your Twitter username (do not include the @ symbol)
TWITTER_PASSWORD=your Twitter password
TWITTER_EMAIL=your Twitter email
TWITTER_API_KEY=your API key
TWITTER_API_SECRET=your API key secret
TWITTER_ACCESS_TOKEN=your access token
TWITTER_ACCESS_SECRET=your access token secret
TWITTER_BEARER_TOKEN=your bearer token
Optional Settings Optional Settings
MAX_TWEET_LENGTH=280 # Maximum length of a tweet
TWITTER_DRY_RUN=false # Test mode
TWITTER_SEARCH_ENABLE=false # Enable search
TWITTER_TARGET_USERS= # Target users
POST_INTERVAL_MIN=90 # Minimum post interval (minutes)
POST_INTERVAL_MAX=180 # Maximum post interval (minutes)
Character Configuration Add the following to the character file (.character.json):
{
"clients": ["twitter"],
"topics": ["Topic 1", "Topic 2"]
}
Features
✅ Photo posting
✅ Keyword-based retweets
✅ Auto-liking
✅ User authentication
Testing
Start with dry run mode
TWITTER_DRY_RUN=true
Check logs for authentication
Test basic functionality
Enable full features

[odilitime]

please don't remove all our READMEs

[kwannz]

Oh sorry my bed Odilitime ***@***.***> 于2025年1月11日周六 11:36写道：

…

***@***.**** requested changes on this pull request. please don't remove all our READMEs — Reply to this email directly, view it on GitHub <#2130 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJ34OOV6VJGN2RDTQGDHNZD2KBDNTAVCNFSM6AAAAABU7A4WSSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKNBUGEZTINRVGE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[github-actions]

This pull request has been automatically marked as stale due to 30 days of inactivity.
If no further activity occurs within 7 days, it will be closed automatically. Please take action if this pull request is still relevant.

[coderabbitai]

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.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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.