https://github.com/acrlakshman/twitter-bot-computational-fluids
Twitter bot that shares computational research posts
https://github.com/acrlakshman/twitter-bot-computational-fluids
cfd cfdspace computational-fluid-dynamics fluid-dynamics mongodb python3 towardselectric twitter-bot
Last synced: about 1 month ago
JSON representation
Twitter bot that shares computational research posts
- Host: GitHub
- URL: https://github.com/acrlakshman/twitter-bot-computational-fluids
- Owner: acrlakshman
- License: mit
- Archived: true
- Created: 2020-07-23T17:17:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T15:53:58.000Z (about 1 year ago)
- Last Synced: 2025-02-05T16:34:13.022Z (3 months ago)
- Topics: cfd, cfdspace, computational-fluid-dynamics, fluid-dynamics, mongodb, python3, towardselectric, twitter-bot
- Language: Python
- Homepage: https://twitter.com/cfdspace
- Size: 2.77 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Twitter bot that shares computational research
:point_right: [@cfdspace](https://twitter.com/cfdspace)
### Hi :wave: I am a twitter bot and my goal is to share all computational research at one place.
---
### Documentation
:point_right: https://acrlakshman.github.io/twitter-bot-computational-fluids/
---
## What do I do?
I search twitter feed every few minutes for some hashtags, focused on computational research and I retweet them for now.
## Can you make me do something else?
Sure you can, just fork me, change some code logic or default hashtags that suits your needs and deploy it as detailed below. But, please put me only to good use.
## Can you tune parameters without restarting me?
Yes you can. Connect to mongodb and change the values in the collection `config`. Some of the things you can do right now are:
- Change number of tweets that I can search for each time I make API call
- Pause me by setting `pause_app: true`. I won't talk to twitter :smile:
- Change hashtags for which I can scan twitter to find content
- Add or remove inclusion or exclusion strings that will be scanned in the full tweet before processing
- Add or remove users whose tweets won't be retweeted
## Want to know a little more on how I work?
- I scan for some tweets with predefined hashtags
- I store them in a database to do further processing. This avoids me to make too many API calls
- I scan for some metadata and post tweets that meet predefined criteria and save both posted tweets and discarded tweets
- Posted and discarded list are used to avoid spamming content. In future I will periodically clean these databases
- `Poll vs Stream`: Currently I rely on polling
- `Context analysis`: For now I can't handle this, but you can extend me to do that
## What hashtags I handle by default?
- `computationalfluiddynamics`
- `multiphaseflows`
- `volumeoffluid`
- `latticeboltzmann`
# Ingredients used
- [tweepy](https://pypi.org/project/tweepy/)
- [pymongo](https://pypi.org/project/pymongo/)
- [mongodb](https://github.com/mongodb/mongo)
---
# How to start me?
## Using docker-compose
### Deploy
- Clone and configure the scripts
```sh
git clone https://github.com/acrlakshman/twitter-bot-computational-fluids twitter-bot
cd twitter-bot
mkdir -p logs db
```
- Enter API keys and ACCESS tokens in `docker-compose.yml`
- Enter desired credentials for mongodb admin.
- Start containers
```sh
docker-compose build
docker-compose up -d
```
### Stop
```sh
docker-compose down
```
## Using docker stack
### Deploy
Make sure to create swarm
```sh
docker swarm init
# or
docker swarm init --advertise-addr
```
```sh
git clone https://github.com/acrlakshman/twitter-bot-computational-fluids twitter-bot
cd twitter-bot
mkdir -p logs db
```
- Enter API keys and ACCESS tokens in `docker-stack.yml`
- Enter desired credentials for mongodb admin.
- Start containers
```sh
docker stack deploy -c docker-stack.yml cfdspace_stack
```
### Stop
```sh
docker stack rm cfdspace_stack
```
## Database and logs
- Database persists in the volume `db`
- App logs are stored in `logs/cfdspace.log`
## Docker images
* [twitter_cfdspace_bot](https://hub.docker.com/repository/docker/acrlakshman/twitter_cfdspace_bot)
### Notes
* This app uses a persistent database, which keeps growing and will consume disk space. For now you need to manually perform the cleanup and keep an eye on the space used by mongodb. I will update the code to automate such that app does this automatically while it is running.
* Any changes made to the source code in `app/` requires rebuilding docker image.