Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hammady/qusasat
Web app, tweet-poster and Telegram bot to show a random qusasa (quote) from renowned author Dr. Ahmed Khalid Tawfik
https://github.com/hammady/qusasat
docker flask heroku herokuapp python python-3 quotes render twitter twitter-api twitter-bot
Last synced: 1 day ago
JSON representation
Web app, tweet-poster and Telegram bot to show a random qusasa (quote) from renowned author Dr. Ahmed Khalid Tawfik
- Host: GitHub
- URL: https://github.com/hammady/qusasat
- Owner: hammady
- License: mit
- Created: 2019-10-18T18:45:23.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-18T16:25:38.000Z (6 months ago)
- Last Synced: 2024-05-19T16:31:58.733Z (6 months ago)
- Topics: docker, flask, heroku, herokuapp, python, python-3, quotes, render, twitter, twitter-api, twitter-bot
- Language: Python
- Homepage: https://qusasat.onrender.com
- Size: 1010 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qusasat
[](https://github.com/hammady/qusasat/actions/workflows/main.yml)
A web app to show a random qusasa (quote) from the book entitled:
Quotes worth burning (قصاصات قابلة للحرق) for the renowned author
[Dr. Ahmed Khalid Tawfik](https://en.wikipedia.org/wiki/Ahmed_Khaled_Tawfik).
Included is a script (`tweet_poster.py`) that automatically posts a tweet with a random quote.
## System requirements
1. [Docker](https://docs.docker.com/install/)
2. There is no number 2!
## Development
### Build
```bash
docker build . -f dev.dockerfile -t qusasat:dev
```
### Run the web app
```bash
docker run -it --rm -p 5000:5000 -v $PWD:/home qusasat:dev
```
Then point your browsear to
[http://localhost:5000](http://localhost:5000) to get a random quote.
The following routes are available:
- [/](http://localhost:5000/): Return a random quote
- [/.json](http://localhost:5000/.json): Return a random quote in JSON format
- [/\](http://localhost:5000/1): Return a specific quote by its ID
- [/\.json](http://localhost:5000/1.json): Return a specific quote by its ID in JSON format
Note that in development mode, editing and saving any file will
refresh the development server automatically and you can refresh
the browser to get your updates.
## Production
### Build
```bash
docker build . -t qusasat:prod
```
### Run the web app
```bash
docker run -it --rm -p 5000:5000 qusasat:prod
```
### Heroku support
The app supports [Heroku](https://www.heroku.com/) out of the box.
Follow the instructions [here](https://devcenter.heroku.com/articles/container-registry-and-runtime)
to deploy this web app using Heroku Container Registry.
Another way, is to deploy by pushing the `master` branch to the `heroku` remote
after configuring it. This is the standard and recommended way.
## Posting tweets
Run the `tweet_poster.py` script after providing some environment variables:
```bash
docker run -it --rm --env-file .env qusasat:prod python tweet_poster.py
```
Where `.env` contains the following twitter tokens:
```
TWITTER_CONSUMER_KEY=???
TWITTER_CONSUMER_SECRET=???
TWITTER_ACCESS_KEY=???
TWITTER_ACCESS_SECRET=???
```
If you want to do a dry run (just print the tweets without posting them),
add an environment variable to the `.env` file:
```
DRY_RUN=1
```
This is useful if you want to see how long tweets will be splitted into
multiple tweets in a thread.
On Heroku, you can supply those tokens using app
[config vars](https://devcenter.heroku.com/articles/config-vars).
To automatically send scheduled tweets, provision the
[Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler) add-on,
and set its command to: `python tweet_poster.py`.
## Sending on Telegram
The app can send quotes to a Telegram channel. To do so, you need to
create a Telegram bot and channel, and get the bot token and the channel ID.
Then, provide the following environment variables:
```
TELEGRAM_CHAT_ID=???
TELEGRAM_BOT_TOKEN=???
MESSAGES_SIGNATURE=???
```
Then, run the `telegram_sender.py` script:
```bash
docker run -it --rm --env-file .env qusasat:prod python telegram_sender.py
```
Message signatures are optional and can be used to add a signature to the end of
each message.
To generate a token for the bot and identify the channel id, check the
official docs for [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API).
## Deploy using AWS Lambda
A Github Action is provided to deploy the app to AWS Lambda.
It is triggered on push to the `master` branch.
To deploy manually do the following:
- Install node 19
- Install Serverless framework: `npm install -g serverless`
- Install dependencies: `npm install`
- Configure AWS credentials: `aws configure`
- Deploy the app:
```bash
TELEGRAM_BOT_TOKEN= \
TELEGRAM_CHAT_ID= \
MESSAGES_SIGNATURE= \
sls deploy --aws-profile --stage prod
```