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

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

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

kwanRoshi
Copy link

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).

kwanRoshi and others added 8 commits January 8, 2025 02:27
- Add sendTweetWithMedia method for handling photo uploads
- Update sendStandardTweet to remove mediaIds parameter
- Add mime-types dependency for media type detection

Co-Authored-By: Leon zhao <[email protected]>
…to-support

feat(twitter): Add Twitter client functionality
@kwanRoshi
Copy link
Author

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

@monilpat monilpat changed the base branch from main to develop January 10, 2025 20:53
Copy link
Collaborator

@odilitime odilitime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please don't remove all our READMEs

@odilitime odilitime marked this pull request as draft January 10, 2025 22:36
@odilitime odilitime changed the title Upload a sample photo via the client. Validate successful posting to Twitter. feat: Upload a sample photo via the client. Validate successful posting to Twitter. Jan 10, 2025
@kwanRoshi
Copy link
Author

kwanRoshi commented Jan 11, 2025 via email

@kwanRoshi kwanRoshi marked this pull request as ready for review January 11, 2025 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants