GAME twitter readme instructions

Author: celesteanglm

plugins/twitter/README.md

@@ -5,39 +5,86 @@ The Twitter plugin is a lightweight wrapper over commonly-used twitter API calls
 ## Installation
 From this directory (`twitter`), run the installation:
 ```bash
-pip install -e .
+poetry install
 ```
 
 ## Usage
-1. If you don't already have one, create a X (twitter) account and navigate to the [developer portal](https://developer.x.com/en/portal/dashboard).
-2. Create a project app, generate the following credentials and set the following environment variables (e.g. using a `.bashrc` or a `.zshrc` file):
-  - `TWITTER_API_KEY`
-  - `TWITTER_API_SECRET_KEY`
-  - `TWITTER_ACCESS_TOKEN`
-  - `TWITTER_ACCESS_TOKEN_SECRET`
-
-3. Import and initialize the plugin to use in your worker:
-```python
-import os
-from twitter_plugin_gamesdk.twitter_plugin import TwitterPlugin
-
-# Define your options with the necessary credentials
-options = {
-    "id": "test_twitter_worker",
-    "name": "Test Twitter Worker",
-    "description": "An example Twitter Plugin for testing.",
-    "credentials": {
-        "apiKey": os.environ.get("TWITTER_API_KEY"),
-        "apiSecretKey": os.environ.get("TWITTER_API_SECRET_KEY"),
-        "accessToken": os.environ.get("TWITTER_ACCESS_TOKEN"),
-        "accessTokenSecret": os.environ.get("TWITTER_ACCESS_TOKEN_SECRET"),
-    },
-}
-# Initialize the TwitterPlugin with your options
-twitter_plugin = TwitterPlugin(options)
-
-# Post a tweet
-post_tweet_fn = twitter_plugin.get_function('post_tweet')
-post_tweet_fn("Hello world!")
-```
-You can refer to `test_twitter.py` for more examples on how to call the twitter functions.
+1. Choose one of the 2 options to initialise the Twitter plugin
+   - `GameTwitterPlugin` 
+     - This allows one to leverage GAME's X enterprise API credentials (i.e. higher rate limits)
+   - `TwitterPlugin`
+     - This allows one to use their own X API credentials
+2. Initialise plugin objects, run set-up scripts and use plugin functions
+   - `GameTwitterPlugin` 
+     - To get the access token to us this plugin, run the following command
+        ```bash
+        poetry run twitter-plugin-gamesdk auth -k <GAME_API_KEY>
+        ```
+        You will see the following output:
+        ```bash
+        Waiting for authentication...
+
+        Visit the following URL to authenticate:
+        https://x.com/i/oauth2/authorize?response_type=code&client_id=VVdyZ0t4WFFRMjBlMzVaczZyMzU6MTpjaQ&redirect_uri=http%3A%2F%2Flocalhost%3A8714%2Fcallback&state=866c82c0-e3f6-444e-a2de-e58bcc95f08b&code_challenge=K47t-0Mcl8B99ufyqmwJYZFB56fiXiZf7f3euQ4H2_0&code_challenge_method=s256&scope=tweet.read%20tweet.write%20users.read%20offline.access
+        ```
+        After authenticating, you will receive the following message:
+        ```bash
+        Authenticated! Here's your access token:
+        apx-<xxx>
+        ```
+     - Set the access token as an environment variable called `GAME_TWITTER_ACCESS_TOKEN` (e.g. using a `.bashrc` or a `.zshrc` file):
+     - Import and initialize the plugin to use in your worker:
+        ```python
+        import os
+        from twitter_plugin_gamesdk.game_twitter_plugin import GameTwitterPlugin
+
+        # Define your options with the necessary credentials
+        options = {
+            "id": "test_game_twitter_plugin",
+            "name": "Test GAME Twitter Plugin",
+            "description": "An example GAME Twitter Plugin for testing.",
+            "credentials": {
+                "gameTwitterAccessToken": os.environ.get("GAME_TWITTER_ACCESS_TOKEN")
+            },
+        }
+        # Initialize the TwitterPlugin with your options
+        game_twitter_plugin = GameTwitterPlugin(options)
+
+        # Post a tweet
+        post_tweet_fn = game_twitter_plugin.get_function('post_tweet')
+        post_tweet_fn("Hello world!")
+        ```
+        You can refer to `test_game_twitter.py` for more examples on how to call the twitter functions. Note that there is a limited number of functions available. If you require more, please submit a feature requests via Github Issues.
+      
+   - `TwitterPlugin`
+     - If you don't already have one, create a X (twitter) account and navigate to the [developer portal](https://developer.x.com/en/portal/dashboard).
+     - Create a project app, generate the following credentials and set the following environment variables (e.g. using a `.bashrc` or a `.zshrc` file):
+       - `TWITTER_API_KEY`
+       - `TWITTER_API_SECRET_KEY`
+       - `TWITTER_ACCESS_TOKEN`
+       - `TWITTER_ACCESS_TOKEN_SECRET`
+     - Import and initialize the plugin to use in your worker:
+        ```python
+        import os
+        from twitter_plugin_gamesdk.twitter_plugin import TwitterPlugin
+
+        # Define your options with the necessary credentials
+        options = {
+            "id": "test_twitter_worker",
+            "name": "Test Twitter Worker",
+            "description": "An example Twitter Plugin for testing.",
+            "credentials": {
+                "apiKey": os.environ.get("TWITTER_API_KEY"),
+                "apiSecretKey": os.environ.get("TWITTER_API_SECRET_KEY"),
+                "accessToken": os.environ.get("TWITTER_ACCESS_TOKEN"),
+                "accessTokenSecret": os.environ.get("TWITTER_ACCESS_TOKEN_SECRET"),
+            },
+        }
+        # Initialize the TwitterPlugin with your options
+        twitter_plugin = TwitterPlugin(options)
+
+        # Post a tweet
+        post_tweet_fn = twitter_plugin.get_function('post_tweet')
+        post_tweet_fn("Hello world!")
+        ```
+        You can refer to `test_twitter.py` for more examples on how to call the twitter functions.