realhardik18 / Book-Wheat

a twitter bot which can categorically save your tweets and supports discord integration!

Home Page:https://bookwheat.herokuapp.com/home

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BookWheat, The ultimate twitter bookmark tool

BookWheat is a Twitter bot that helps you save important tweets which are relevant to you categorically! it also supports discord integration, which means with a quick setup, you can now send important tweets to your favorite discord text channel!

BookWheat on twitter

Overview video!

Here's a short video that explains how BookWheat was made, and the tools it uses such as Redis,Tweepy,Heroku and Discord.py vid click on it to watch it on youtube!

How it works

How the data is stored:

the data is stored in the form of redis keys. each key stores the information related to a particular user. the file db_methods.py has various methods to retrive the data and store it. in a particular key, the bot stores the twitter handle and user id of the associated user, along side this it also stores the data of all the saved tweets of that particular user. this data has the name of each category, the discord webhook url for this category(for discord intergration) and a list of tweets saved!

How the data is accessed:

when ever the bot has to retrive the saved tweets of the authorized user via the website, it searches the all the keys for the desired user, and then returns all the data stored for that particular user, this data is then displayed on the website portal. retriving methods are also stored under db_methods.py

How to run it locally?

to run the Twitter Bot locally first clone the repo

  • then navigate to the twitter bot folder
  • now run pip install -r requirements.txt in the terminal to download all the associated packages
  • now create a file called creds.py and fill out the following information instructions now you can run main.py and your bot will be up and running!

Prerequisites

python 3.9+

More Information about Redis Stack

Here some resources to help you quickly get started using Redis Stack. If you still have questions, feel free to ask them in the Redis Discord or on Twitter.

Getting Started

  1. Sign up for a free Redis Cloud account using this link and use the Redis Stack database in the cloud.
  2. Based on the language/framework you want to use, you will find the following client libraries:

The above videos and guides should be enough to get you started in your desired language/framework. From there you can expand and develop your app. Use the resources below to help guide you further:

  1. Developer Hub - The main developer page for Redis, where you can find information on building using Redis with sample projects, guides, and tutorials.
  2. Redis Stack getting started page - Lists all the Redis Stack features. From there you can find relevant docs and tutorials for all the capabilities of Redis Stack.
  3. Redis Rediscover - Provides use-cases for Redis as well as real-world examples and educational material
  4. RedisInsight - Desktop GUI tool - Use this to connect to Redis to visually see the data. It also has a CLI inside it that lets you send Redis CLI commands. It also has a profiler so you can see commands that are run on your Redis instance in real-time
  5. Youtube Videos

About

a twitter bot which can categorically save your tweets and supports discord integration!

https://bookwheat.herokuapp.com/home

License:MIT License


Languages

Language:Python 57.7%Language:HTML 37.6%Language:CSS 4.6%Language:Procfile 0.1%