dark-firepit/Twxtter-main
Archived
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

updated readme some more

Browse source
This commit is contained in:
robinuniverse 2021-07-11 15:51:59 -05:00
parent 2f9f160b34
commit 0d5d4a04db
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
readme.md
View file

@ -24,7 +24,27 @@ this script uses the youtube-dl python module, along with flask and pymongo, so
By default I have the port set to 80, just cause that's what was convenient for me, but it can easily be changed, either using an environment variable, or changing the bottom line of the script itself
I have included some files to give you a head start on setting this server up with uWSGI, though if you decide to use uWSGI I suggest you set up mongoDB link caching by going into the script and change `link_cache_system` from `"json"` to `"db"`, and inserting you mongoDB address, as having many workers writing to the same json file doesn't really work
I have included some files to give you a head start on setting this server up with uWSGI, though if you decide to use uWSGI I suggest you set up mongoDB link caching
### Config
TwitFix generates a config.json in its root directory the first time you run it, the options are:
**API** - This will be where you put the credentials for your twitter API if you use this method
**database** - This is where you put the URL to your mongoDB database if you are using one
**link_cache** - (Options: **db**, **json**)
- **db**: Caches all links to a mongoDB database. This should be used it you are using uWSGI and are not just running the script on its own as one worker
- **json**: This saves cached links to a local **links.json** file
**method** - ( Options: **youtube-dl**, **api**, **hybrid** ) **[NOT YET IMPLEMENTED!]**
- **youtube-dl**: the original method for grabbing twitter video links, this uses a guest token provided via youtube-dl and should work well for individual instances, but may not scale up to a very large amount of usage
- **api**: this directly uses the twitter API to grab tweet info, limited to 900 calls per 15m
- **hybrid**: This will start off by using the twitter API to grab tweet info, but if the rate limit is reached it will switch over to youtube-dl to avoid downtime
This project is licensed under the **Do What The Fuck You Want Public License**