muskit/NijiHolo_EN_ID_Bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README.md

Browse Source
This commit is contained in:
muskit
2024-03-17 23:52:00 -07:00
parent c88ddc749a
commit af7ce7150b
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -16
View File
@@ -36,17 +36,17 @@ These need to be defined in a `.env` file in the `run` ephemeral directory.
### Scraper Credentials ### Scraper Credentials
To get around rate limitations imposed on users, we scrape with multiple accounts. Each account is defined in the file using the following format: To get around rate limitations imposed on users, we scrape with multiple accounts. Each account is defined in the file using the following format:
``` ```
scraper_usernameX=twitter_username scraper_username_X=twitter_username
scraper_passwordX=twitter_password scraper_auth_token_X=twitter_auth_token
``` ```
where `X` is a number starting from 0, increasing by 1 for each account added. For instance: where `X` is a number starting from 0, increasing by 1 for each account added. For instance:
``` ```
scraper_username0= scraper_username_0=
scraper_password0= scraper_auth_token_0=
scraper_username1= scraper_username_1=
scraper_password1= scraper_auth_token_1=
``` ```
The first account (`scraper_username0` and `scraper_password0`) **MUST be defined (`scraper_username` and `scraper_password` without number will not work!)** and will be used to attempt scraping private accounts. Make sure this account follows any private accounts that you want to scrape! The first account (`scraper_username_0` and `scraper_auth_token_0`) **MUST be defined (`scraper_username_` and `scraper_auth_token_` without number will not work!)** and will be used to attempt scraping private accounts. Make sure this account follows any private accounts that you want to scrape!
### Twitter API Stuff ### Twitter API Stuff
The following keys/tokens are used for the official API via `tweepy`. We mainly use these to just post tweets. The following keys/tokens are used for the official API via `tweepy`. We mainly use these to just post tweets.
``` ```
@@ -56,20 +56,20 @@ user_token=
user_secret= user_secret=
``` ```
### Screenshot Cookie *(optional)* ### Screenshot Cookie *(optional)*
This is the authentication token obtained from a browser when signed in on the Twitter website. It's only needed if you want to screenshot tweets from privated accounts. Make sure the token belongs to an account that follows desired private accounts! Maybe have it belong to `scraper_username0`? This is the authentication token obtained from a browser when signed in on the Twitter website. It's only needed if you want to screenshot tweets from privated accounts. Make sure the token belongs to an account that follows desired private accounts! Maybe have it belong to `scraper_username_0`?
``` ```
web_auth_token= web_auth_token=
``` ```
### Example `.env` without values ### Example `.env` without values
``` ```
scraper_username0= scraper_username_0=
scraper_password0= scraper_auth_token_0=
scraper_username1= scraper_username_1=
scraper_password1= scraper_auth_token_1=
scraper_username2= scraper_username_2=
scraper_password2= scraper_auth_token_2=
scraper_username3= scraper_username_3=
scraper_password3= scraper_auth_token_3=
web_auth_token= web_auth_token=
app_key= app_key=
app_secret= app_secret=