Public Python Apps

This repository contains my collection of Python applications that run inside of a Docker container.

Table of Contents

• Blackvue 970 XP Downloader
  • Purpose
  • Command Line Parameters
  • Usage
  • Docker Container
  • Example Output
• Environment Variable Logger
  • Configuration
  • Examples

Applications

Blackvue 970 XP Downloader

Purpose

The Blackvue 970 XP Downloader script is designed to download video files from the Blackvue 970 XP dashcam. It connects to the dashcam via HTTP, retrieves a list of available files and downloads them to a local directory. If the file already exists and the byte size matches, it will skip over that video file.

Compatibility

This script has been tested on the following devices:

• Blackvue 970 XP

Note

It should work with any other Blackvue that uses the same HTTP method to download the video files. If it does, please consider raising a pull request to update the list of compatible devices. Thanks!

Command Line Parameters

The script accepts the following command line parameters:

• --host <hostname or IP address>: The hostname or IP address of the Blackvue 970 XP.
• --port <port number>: The port number of the Blackvue 970 XP. Default is 80.
• --protocol <protocol>: The protocol to use for the connection. Default is http.
• --save-to <output directory>: The directory where the files will be saved. Default is ./downloads.

Usage

To run the script, use the following command:

python app.py \
  --host <hostname or IP address> \
  --port <port number> \
  --protocol <protocol> \
  --save-to <output directory>

Example:

python app.py \
  --host 192.168.1.1 \
  --port 80 \
  --protocol http \
  --save-to downloads

Docker Container

The script can also be run inside a Docker container. The docker-compose.yaml file is configured to build and run the container for the Blackvue 970 XP Downloader.

To build and run the container, use the following commands:

docker-compose build blackvue
docker-compose up blackvue

If you do not want to use Docker Compose, then you can build and run the container as follows.

Building the image..

cd <git repo>
docker build \
  --build-arg APP_SOURCE=blackvue \
  --tag python_blackvue:latest .

Running the image..

docker run \
  --rm \
  --name blackvue \
  --build-arg APP_SOURCE=blackvue \
  -v $(pwd)/apps/blackvue:/home/appuser/app \
  python_blackvue:latest

Example Output

When the script runs, it will log the progress of downloading files from the BlackVue dashcam. Example output:

Blackvue 970 XP Downloader started
Progress: 1 of 10: /Record/20241217_205239_EF.mp4.. 10.0%
Progress: 1 of 10: /Record/20241217_205239_EF.mp4.. 20.0%
Progress: 1 of 10: /Record/20241217_205239_EF.mp4.. 30.0%
...
Complete: 1 of 10: /Record/20241217_205239_EF.mp4
Progress: 2 of 10: /Record/20241217_205239_ER.mp4.. 10.0%
...
Complete: 2 of 10: /Record/20241217_205239_ER.mp4

Environment Variable Logger

This is a Python app which runs inside a container, periodically emitting JSON formatted messages to the console, using the Kubernetes Recommended Labels format as inspiration.

I say "inspriation" because the labels emitted are an extension to the Kubernetes Recommended Labels, to support multiple name, component, and version pairs. Actually, there's no limitation to what the label keys are and which have multiple values.

Configuration

The following environment variables are supported:

Name	Value	Description
EV_LOGGER_PREFIX	(string)	Mandatory. The prefix all other environment variables need to use.
EV_LOGGER_SYSLOG	(number)	Optional. Set this to 1 to enable logging to syslog. Anything else will use stdout/err. Default is 0.
EV_LOGGER_INTERVAL	(number)	Optional. The interval in seconds the log is emitted to the console. Default is 300 (5 minutes). It must be greater than 0 and less than 604800 (1 week). Setting this to 0 will result in logging once only and then exiting successfully.
EV_LOGGER_INDENT	(number)	Optional. The number of spaces to indent the JSON message. Default is 0. Must be greater than or equal to 0.
<EV_LOGGER_PREFIX>_<KEY>	(string)	Mandatory. The label key and value to log (see below). Must have at least 1.

The label key and value to log are configured via environment variables, using the following syntax:

<EV_LOGGER_PREFIX>_<KEY>="<VALUE>"

Where...

Field	Description
<KEY>	Represents the key name.
<VALUE>	Represents the key value.

If <VALUE> contains a string formatted as <PARENT_KEY>[__<ID>_]_<CHILD_KEY>, it indicates a JSON array of objects, where:

Field	Description
<PARENT_KEY>	Represents the parent key name.
<ID>	Represents the index of the array element.
<CHILD_KEY>	Represents the child key name.

Note: All label keys and sub-keys are converted to lower case.

Examples

Example 1

The following is an example of the environment variable syntax in practice:

EV_LOGGER_PREFIX="APP_CONTOSO_MS"
EV_LOGGER_SYSLOG=0
EV_LOGGER_INDENT=2
EV_LOGGER_INTERVAL=600
APP_CONTOSO_MS_INSTANCE="my-instance"
APP_CONTOSO_MS_MANAGED_BY="my-team"
APP_CONTOSO_MS_PART_OF="my-collection"
APP_CONTOSO_MS_INVENTORY__0__NAME="my-app"
APP_CONTOSO_MS_INVENTORY__0__VERSION="v1"
APP_CONTOSO_MS_INVENTORY__0__COMPONENT="my-component"
APP_CONTOSO_MS_INVENTORY__1__NAME="my-app2"
APP_CONTOSO_MS_INVENTORY__1__VERSION="v2"
APP_CONTOSO_MS_INVENTORY__1__COMPONENT="my-component2"

The above configuration will produce the following JSON string (pretty formatted), every 10 minutes:

{
  "time": "2024-04-27 01:39:30",
  "level": "INFO",
  "message": "Starting Kubernetes Label Emitter v2.1.0. Interval: 600 seconds"
}
{
  "app.contoso.ms/interval": "600",
  "app.contoso.ms/instance": "my-instance",
  "app.contoso.ms/managed.by": "my-team",
  "app.contoso.ms/part.of": "my-collection",
  "app.contoso.ms/inventory": [
    {
      "name": "my-app",
      "version": "v1",
      "component": "my-component"
    },
    {
      "name": "my-app2",
      "version": "v2",
      "component": "my-component2"
    }
  ]
}

Example 2

The following is the same as Example 1 but without any JSON indentation:

EV_LOGGER_PREFIX="APP_CONTOSO_MS"
EV_LOGGER_SYSLOG=0
EV_LOGGER_INDENT=0
EV_LOGGER_INTERVAL=600
APP_CONTOSO_MS_INSTANCE="my-instance"
APP_CONTOSO_MS_MANAGED_BY="my-team"
APP_CONTOSO_MS_PART_OF="my-collection"
APP_CONTOSO_MS_INVENTORY__0__NAME="my-app"
APP_CONTOSO_MS_INVENTORY__0__VERSION="v1"
APP_CONTOSO_MS_INVENTORY__0__COMPONENT="my-component"
APP_CONTOSO_MS_INVENTORY__1__NAME="my-app2"
APP_CONTOSO_MS_INVENTORY__1__VERSION="v2"
APP_CONTOSO_MS_INVENTORY__1__COMPONENT="my-component2"

The above configuration will produce the following JSON string to the console, every 10 minutes:

{"time": "2024-04-27 01:39:30", "level": "INFO", "message": "Starting Kubernetes Label Emitter v2.1.0. Interval: 600 seconds"}
{"time": "2024-04-27 01:39:30", "level": "INFO", "message": {"app.contoso.ms/instance": "my-instance", "app.contoso.ms/managed.by": "my-team", "app.contoso.ms/part.of": "my-collection", "app.contoso.ms/inventory": [{"name": "my-app", "version": "v1", "component": "my-component"}, {"name": "my-app2", "version": "v2", "component": "my-component2"}]}}