Skip to content

twitter_app_auth

arai_ai_agents.auth.twitter_app_auth

TwitterAppAuth

A class for authenticating with the Twitter API using OAuth 1.0a.

Attributes:

Name Type Description
api_key str

The API key for the Twitter API.
api_secret_key str

The API secret key for the Twitter API.
bearer_token str

The bearer token for the Twitter API.
Source code in arai_ai_agents/auth/twitter_app_auth.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class TwitterAppAuth:
    """
    A class for authenticating with the Twitter API using OAuth 1.0a.

    Attributes:
        api_key (str): The API key for the Twitter API.
        api_secret_key (str): The API secret key for the Twitter API.
        bearer_token (str): The bearer token for the Twitter API.
    """
    def __init__(self):
        """Initializes the TwitterAppAuth class.

        Example:
            >>> twitter_auth = TwitterAppAuth()
        """
        self.api_key = os.getenv("TWITTER_API_KEY") 
        self.api_secret_key = os.getenv("TWITTER_API_KEY_SECRET") 
        self.bearer_token = os.getenv("TWITTER_BEARER_TOKEN") 

    def setup_twitter_auth(self):
        """Sets up the Twitter authentication.

        Raises:
            ValueError: If Twitter API credentials are not present in the environment variables.

        Example:
            >>> twitter_auth.setup_twitter_auth()
        """
        try:
            # Initialize OAuth 1.0a handler
            self.auth = tweepy.OAuth1UserHandler(
                consumer_key=self.api_key,
                consumer_secret=self.api_secret_key,
                callback="oob"  # Use out-of-band OAuth
            )

            # Get the authorization URL
            try:
                auth_url = self.auth.get_authorization_url()
                print("\n1. Visit this URL to authorize your app:")
                print(auth_url)

                # Open the URL in default browser
                webbrowser.open(auth_url)

                # Get the verifier code from user
                print("\n2. Enter the PIN shown on the website:")
                verifier = input("> ").strip()

                # Get the access tokens
                try:
                    access_token, access_token_secret = self.auth.get_access_token(verifier)

                    print("\nSuccess! Add these tokens to your .env file:")
                    print(f"\nTWITTER_ACCESS_TOKEN={access_token}")
                    print(f"TWITTER_ACCESS_TOKEN_SECRET={access_token_secret}")

                    # Test the credentials
                    self.client = tweepy.Client(
                        bearer_token=self.bearer_token,
                        consumer_key=self.api_key,
                        consumer_secret=self.api_secret_key,
                        access_token=access_token,
                        access_token_secret=access_token_secret
                    )

                    me = self.client.get_me()
                    print(f"\nSuccessfully authenticated as @{me.data.username}")

                    self.save_credentials(access_token, access_token_secret)

                except Exception as e:
                    print(f"\nError getting access tokens: {str(e)}")

            except Exception as e:
                print(f"\nError getting authorization URL: {str(e)}")
                print("\nMake sure your app has OAuth 1.0a enabled in the Twitter Developer Portal:")
                print("1. Go to https://developer.twitter.com/en/portal/projects")
                print("2. Select your project and app")
                print("3. Go to 'User authentication settings'")
                print("4. Enable 'OAuth 1.0a'")
                print("5. Set App permissions to 'Read and Write'")
                print("6. Add 'http://127.0.0.1' to callback URLs")

        except Exception as e:
            print(f"\nSetup error: {str(e)}")
            print("\nCheck that your API credentials are correct in .env file:")
            print("TWITTER_API_KEY")
            print("TWITTER_API_KEY_SECRET")


    def save_credentials(self, access_token, access_token_secret):
        """Saves the Twitter access tokens to a YAML file.

        Args:
            access_token (str): The access token for the Twitter API.
            access_token_secret (str): The access token secret for the Twitter API.

        Example:
            >>> twitter_auth.save_credentials(access_token, access_token_secret)
        """
        try:                  
            tokens = {
                'TWITTER_ACCESS_TOKEN': access_token,
                'TWITTER_ACCESS_TOKEN_SECRET': access_token_secret
            }

            with open('twitter_tokens.yaml', 'w') as f:
                yaml.dump(tokens, f)

            print("\nSuccess! Tokens have been saved to twitter_tokens.yaml")

        except Exception as e:
            print(f"\nError saving tokens: {str(e)}")

__init__()

Initializes the TwitterAppAuth class.

Example

twitter_auth = TwitterAppAuth()

Source code in arai_ai_agents/auth/twitter_app_auth.py 
34
35
36
37
38
39
40
41
42
def __init__(self):
    """Initializes the TwitterAppAuth class.

    Example:
        >>> twitter_auth = TwitterAppAuth()
    """
    self.api_key = os.getenv("TWITTER_API_KEY") 
    self.api_secret_key = os.getenv("TWITTER_API_KEY_SECRET") 
    self.bearer_token = os.getenv("TWITTER_BEARER_TOKEN")

save_credentials(access_token, access_token_secret)

Saves the Twitter access tokens to a YAML file.

Parameters:

Name Type Description Default
access_token str

The access token for the Twitter API.

 required
access_token_secret str

The access token secret for the Twitter API.

 required
Example

twitter_auth.save_credentials(access_token, access_token_secret)

Source code in arai_ai_agents/auth/twitter_app_auth.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def save_credentials(self, access_token, access_token_secret):
    """Saves the Twitter access tokens to a YAML file.

    Args:
        access_token (str): The access token for the Twitter API.
        access_token_secret (str): The access token secret for the Twitter API.

    Example:
        >>> twitter_auth.save_credentials(access_token, access_token_secret)
    """
    try:                  
        tokens = {
            'TWITTER_ACCESS_TOKEN': access_token,
            'TWITTER_ACCESS_TOKEN_SECRET': access_token_secret
        }

        with open('twitter_tokens.yaml', 'w') as f:
            yaml.dump(tokens, f)

        print("\nSuccess! Tokens have been saved to twitter_tokens.yaml")

    except Exception as e:
        print(f"\nError saving tokens: {str(e)}")

setup_twitter_auth()

Sets up the Twitter authentication.

Raises:

Type Description
ValueError

If Twitter API credentials are not present in the environment variables.
Example

twitter_auth.setup_twitter_auth()

Source code in arai_ai_agents/auth/twitter_app_auth.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def setup_twitter_auth(self):
    """Sets up the Twitter authentication.

    Raises:
        ValueError: If Twitter API credentials are not present in the environment variables.

    Example:
        >>> twitter_auth.setup_twitter_auth()
    """
    try:
        # Initialize OAuth 1.0a handler
        self.auth = tweepy.OAuth1UserHandler(
            consumer_key=self.api_key,
            consumer_secret=self.api_secret_key,
            callback="oob"  # Use out-of-band OAuth
        )

        # Get the authorization URL
        try:
            auth_url = self.auth.get_authorization_url()
            print("\n1. Visit this URL to authorize your app:")
            print(auth_url)

            # Open the URL in default browser
            webbrowser.open(auth_url)

            # Get the verifier code from user
            print("\n2. Enter the PIN shown on the website:")
            verifier = input("> ").strip()

            # Get the access tokens
            try:
                access_token, access_token_secret = self.auth.get_access_token(verifier)

                print("\nSuccess! Add these tokens to your .env file:")
                print(f"\nTWITTER_ACCESS_TOKEN={access_token}")
                print(f"TWITTER_ACCESS_TOKEN_SECRET={access_token_secret}")

                # Test the credentials
                self.client = tweepy.Client(
                    bearer_token=self.bearer_token,
                    consumer_key=self.api_key,
                    consumer_secret=self.api_secret_key,
                    access_token=access_token,
                    access_token_secret=access_token_secret
                )

                me = self.client.get_me()
                print(f"\nSuccessfully authenticated as @{me.data.username}")

                self.save_credentials(access_token, access_token_secret)

            except Exception as e:
                print(f"\nError getting access tokens: {str(e)}")

        except Exception as e:
            print(f"\nError getting authorization URL: {str(e)}")
            print("\nMake sure your app has OAuth 1.0a enabled in the Twitter Developer Portal:")
            print("1. Go to https://developer.twitter.com/en/portal/projects")
            print("2. Select your project and app")
            print("3. Go to 'User authentication settings'")
            print("4. Enable 'OAuth 1.0a'")
            print("5. Set App permissions to 'Read and Write'")
            print("6. Add 'http://127.0.0.1' to callback URLs")

    except Exception as e:
        print(f"\nSetup error: {str(e)}")
        print("\nCheck that your API credentials are correct in .env file:")
        print("TWITTER_API_KEY")
        print("TWITTER_API_KEY_SECRET")