Update more README info since adding features

This commit is contained in:
Jxck-S 2020-08-15 17:48:53 -04:00
parent 72dc3c56a3
commit 7dfafaa19a
1 changed files with 13 additions and 7 deletions

View File

@ -3,8 +3,7 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c4e1d839eec3468cadfe351d64dc1ac4)](https://app.codacy.com/manual/Jxck-S/plane-notify?utm_source=github.com&utm_medium=referral&utm_content=Jxck-S/plane-notify&utm_campaign=Badge_Grade_Settings)
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)
Nearing final first version. Notify If a Selected Plane has taken off or landed using Python with OpenSky API, outputs location of takeoff location of landing and takeoff by revese lookup of cordinates.
Notify If a Selected Plane has taken off or landed using Python with OpenSky or ADS-B Data, outputs location of takeoff location of landing and takeoff by revese lookup of cordinates.
## Why I made it
@ -22,14 +21,16 @@ Made it so I could track Elon Musk's Jet and share with others of his whereabout
- At time of takeoff a takeoff time is set which is refrenced in landing event to calculate an approximate total flight time.
- Static map image is created based off location name. (Google Static Maps API)
- Static map image is created based off location name. (Google Static Maps API) or a screenshot of <https://global.adsbexchange.com/> is created using Selenium/ChromeDriver The selected plane is locked on in the screenshot.
- If the landing event and takeoff events are true creates the output to Twitter and Pushbullet, uses the location name, map image and takeoff time if landing. (Tweepy and Pushbullet )
- If the landing event and takeoff events are true creates the output to any of the following built in outputs(Twitter, Pushbullet, and Discord all of which can be setup and enabled in config.ini). Outputs the location name, map image and takeoff time if landing. (Tweepy and "Pushbullet.py" and Discord_webhooks)
## Required PIP packages
- OpenSky API <https://github.com/openskynetwork/opensky-api>
- OpenSky API <https://github.com/openskynetwork/opensky-api> (If using Opensky, which is default and anybody can use)
- geopy <https://github.com/geopy/geopy>
- colorama <https://github.com/tartley/colorama>
### Install OpenSky API
@ -47,13 +48,16 @@ pip install colorama
pip install geopy
```
### Install Pushbullet and Tweepy optional output methods already implemented in code
### Install Pushbullet, Tweepy, and Discord optional output methods already implemented in code
```bash
pip install tweepy
pip install pushbullet.py
pip install discord_webhooks
```
Configure these methods of output in config.ini
### Install Screen to run in background
```bash
@ -73,7 +77,7 @@ git clone https://github.com/Jxck-S/plane-notify.git
cd plane-notify
```
### Configure config file with keys and urls
### Configure config file with keys and urls (config.ini)
- edit them with nano or vi on the running machine or on your pc and transfer the config to where you will be running the bot
@ -91,6 +95,8 @@ python3 NotifyBot.py
### TODO
move lookup location of coordinates only when landing or takeoff occurs so the Geopy/Nomination is called less
implement airport name, done by closest airport
#### Refrences