Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plcnk/TwitterFlightBot
(ARCHIVED) A Twitter bot that tells you information about a flight by it's number or callsign.
https://github.com/plcnk/TwitterFlightBot
aviation bot flight flight-radar flightradar24 flightradar24-api python python3 tweepy twitter twitter-api twitter-bot
Last synced: 2 months ago
JSON representation
(ARCHIVED) A Twitter bot that tells you information about a flight by it's number or callsign.
- Host: GitHub
- URL: https://github.com/plcnk/TwitterFlightBot
- Owner: plcnk
- License: mit
- Archived: true
- Created: 2022-08-08T22:38:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T18:46:09.000Z (over 1 year ago)
- Last Synced: 2024-02-15T04:34:26.067Z (11 months ago)
- Topics: aviation, bot, flight, flight-radar, flightradar24, flightradar24-api, python, python3, tweepy, twitter, twitter-api, twitter-bot
- Language: Python
- Homepage: https://twitter.com/FlightStatusBot
- Size: 77.1 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flying - TwitterFligthBot
README
# (ARCHIVED) Twitter Flight Bot
This bot will return information about a flight when you tag it with its flight number or its callsign.
To use it, you need to tag it by its Twitter handle [@FlightStatusBot](https://twitter.com/FlightStatusBot) and follow with a flight number / callsign like so: `.@FlightStatusBot U2189`.
The bot will reply to you with the following information:
* The airline name with the flight number / callsign
* The origin airport name
* The actual departure time in UTC timezone
* The arrival airport name
* The Estimated Time of Arrival in UTC timezone
* The altitude in feet
> **Note** -
> Be aware that the flight must be active for the bot to work, meaning the plane's transponder must be on.
The code is written in Python and uses [Tweepy](https://pypi.org/project/tweepy/) for the Twitter connection and [FlightRadarAPI](https://pypi.org/project/FlightRadarAPI/) for the Flghtradar24 API.
This bot is not affiliated with [Flightradar24](https://www.flightradar24.com/) in any way.
## Setup
To run the code yourself, you will need to create an App on the [Twitter Developer Portal](https://developer.twitter.com/en/portal/dashboard) and generated your tokens to be able to use the API.
After that, there are multiple methods to run this bot.
### First method: Use the Docker image (recommended)
A [Docker image](https://hub.docker.com/r/plck/twitterflightbot) is available for this project, which makes it easier for production environment and is the method I would recommend. You will first need to have [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine for this to work.
First, cd into this repository:
```shell
cd ./TwitterFlightBot
```
Then, edit the `docker-compose.yml` file with your Twitter API credentials:
```yaml
environment:
TWITTER_API_KEY: "XXXXX"
TWITTER_API_KEY_SECRET: "XXXXX"
TWITTER_ACCESS_TOKEN: "XXXXX"
TWITTER_ACCESS_TOKEN_SECRET: "XXXXX"
TWITTER_BEARER_TOKEN: "XXXXX"
```
Finally, start the bot using this command:
```shell
docker compose up -d
```
If you want to stop the bot, use this command:
```shell
docker compose down
```
### Second method: Directly run the code
You can directly run the code on your machine or your VM. You will need to have Python3 installed, which comes by default on most Linux distros.
If you don't have it, install pip:
```shell
sudo apt install python3-pip
```
First, cd into this repository:
```shell
cd ./TwitterFlightBot
```
I recommend using a virtual environment to run the code, you can find out how to use this [here](https://docs.python.org/3/tutorial/venv.html). It is not required, but I highly recommend virtualenvs to avoid breaking your main environment.
After that, install the required packages with this command:
```shell
pip install -r requirements.txt
```
Next, you will need to export your Twitter API credentials as environment variables:
```shell
export TWITTER_API_KEY="XXXXX"
export TWITTER_API_KEY_SECRET="XXXXX"
export TWITTER_ACCESS_TOKEN="XXXXX"
export TWITTER_ACCESS_TOKEN_SECRET="XXXXX"
export TWITTER_BEARER_TOKEN="XXXXX"
```
Finally, start the bot with `python main.py`.
## License
This project is licensed under MIT License. See [LICENSE](https://github.com/plcnk/TwitterFlightBot/blob/master/LICENSE) for more details.