diff --git a/README.md b/README.md index b44730a..274a208 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ Notify If a Selected Plane has taken off or landed using Python with OpenSky or ADS-B Exchange Data, outputs location of takeoff location of landing and takeoff by reverse lookup of coordinates. +### Branches + +Their are two branches of this program single is the original only supports one plane works with OpenSky and ADSBX. Multi branch is the new version supports multiple planes currently only works with ADSBX, will eventually implement OpenSky. Your current viewing single. + ### Discord Output Example ![Discord Output Example](./ExImages/DiscordEX.png?raw=true) @@ -33,20 +37,12 @@ Made it so I could track Elon Musk's Jet and share with others of his whereabout - If the landing event and takeoff events are true, It will output to any of the following built-in output methods. (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 (If using OpenSky, which is default and anybody can use) - -- geopy - -- colorama - -### Install OpenSky API +### Make sure Python/PIP is installed ```bash -apt install git -git clone https://github.com/openskynetwork/opensky-api.git -pip install -e ~/opensky-api/python +apt update +apt install python3 +apt install python3-pip ``` ### Install Colorama and geopy @@ -56,7 +52,29 @@ pip install colorama pip install geopy ``` -### Install Pushbullet, Tweepy, and Discord optional output methods already implemented in code +### Install Selenium / ChromeDriver or setup Google Static Maps + +Selenium/ChromeDriver is used to take a screenshot of the plane on globe.adsbexchange.com. Or use Google Static Maps, which can cost money if over used(No tutorial use to get to a key). + +#### 1. Chromium + +``` +sudo apt-get install chromium +``` + +#### 2. ChromeDriver + +``` +sudo apt-get install chromium-driver +``` + +#### 3. Selenium + +``` +pip install -U selenium +``` + +### Install Pushbullet, Tweepy, and Discord optional output methods already implemented in code, only install the ones you want to use. ```bash pip install tweepy @@ -72,16 +90,11 @@ Configure these methods of output in config.ini apt install screen ``` -### Make sure Python is installed - -```bash -apt install python3 -``` - ### Download / Clone ```bash -git clone https://github.com/Jxck-S/plane-notify.git +apt install git +git clone -b single --single-branch https://github.com/Jxck-S/plane-notify.git cd plane-notify ``` @@ -104,6 +117,6 @@ python3 NotifyBot.py ### TODO - Possibly implement airport name, done by closest airport -- General Cleanup +- General Cleanup ### [ More Refrences / Documentation](Refrences.md) diff --git a/Refrences.md b/Refrences.md index 82e01ac..ee76720 100644 --- a/Refrences.md +++ b/Refrences.md @@ -12,7 +12,11 @@ ## GeoPy - Location Name Lookup - +- +## Colorama + +- ## Google Static Maps -