Simple Python RSS feed tracker for rpiLocator

• Python 3.6

A Python virtual environment doesn't have to be used, but is recommend.

python -m venv ./pilocatorEnv; \
source ./pilocatorEnv/bin/activate; \
pip install -r requirements.txt

This step isn't required if you don't want to send a Telegram message, run script without pass -t flag.

In the root dir of repo a .env file will need to be created. If using Docker secrets, or passing in environmental variables with another method just make sure variables in .env match.

BOT_TOKEN=

Follow these instructions for obtaining a Telegram bot and the API Token. Steps referenced are from apprise Telegram Docs

Telegram notifications require you to create a bot. It's only after this is done that you will gain a vital piece of information Apprise needs called the Token Identifier (or bot_token).

To do this you will have to open a communication (inside Telegram) to the BotFather. He is available to all users signed up to the platform. Once you've got a dialog box open to him:

1. Type: /newbot
2. Answer the questions it asks after doing this (which get the name of it, etc).
3. When you've completed step 2, you will be provided a bot_token that looks something like this: 123456789:alphanumeric_characters.
4. Type /start now in the same dialog box to enable and instantiate your brand new bot.

Don't share this Telegram Bot Token with anyone else, or push into a public location like accidentally onto Github

Script is run with the following optional parameters python run.py [-h] [-a AGE] [-m MODEL] [-r REGION] [-t TRIAL], use -h flag for help and more information.

Use Cron to have this script automatically run whenever you desire. Though run aggressively and rpiLocator will block access to the site. In their words, "If you are looking to create a notification system for personal use, please use the RSS feed and don't hit the site more than once a minute. High frequency bots will get blocked." I do 4 times a day, each 6 hours apart.

To access cron, use the command crontab -l to view your user cronjobs, and crontab -e to edit them.

0 */6 * * * /path/to/correct/python Path/To/Repository/run.py -a 0 -r US -m CM4 > /dev/null

Follow steps from run commands periodically with anacron on Linux reference found at bottom of readme.

Build the docker image with command docker build -t rpilocator-alert .

Run docker image with command docker run -it --rm --env BOT_TOKEN=<TOKEN> rpilocator-alert [...] The flags shown above for running run.py are passed in same way after image name.

If you do not want to pass in the Telegram API token through env variable, use a docker secret instead. Or if you don't want to send a message use the -t flag.

Have Minikube installed and started withe minikube start. Assuming Minikube is running on same host as this repo. With image built above, push to the local minikube with minikube image load rpilocator-alert. Check that the image is present with minikube image ls --format table. To run the image from the command line kubectl run rpilocator-alert-container --image=rpilocator-alert --image-pull-policy=Never --restart=Never -- -t -a 10. This doesn't message, for that add the --env="DNS_DOMAIN=cluster" flag to kubectl run .... To view the logs use kubectl logs rpilocator-alert-container.

Python linting uses pylint and flake8.

A general pylint check will use following pylint command pylint $(git ls-files '*.py');

A general flake8 check will check for everything. But for continuous integration the command used will be flake8 . --count --show-source --statistics --exclude flaskEnv/

flake8 --exclude flaskEnv/

Linting can also be done with Python Black, black <file>.

• rpilocator
• Python reading RSS feed
• Python send email gmail - No longer used, but still good reference. Pull repo tag 1.0 for its use here.
• apprise messaging library
• Run commands periodically with anacron on Linux
• Using Local Docker Images With MiniKube
• Docker Docs: Deploy to Kubernetes