updates

snstac · Jun 22, 2024 · c7c61b5 · c7c61b5
1 parent 5a0d3a5
commit c7c61b5
Show file tree

Hide file tree

Showing 16 changed files with 87 additions and 74 deletions.
diff --git a/.github/workflows/debian.yml b/.github/workflows/debian.yml
@@ -1,4 +1,4 @@
-name: Build Debian package
+name: Build Debian Package
 
 on:
   push:
@@ -15,36 +15,19 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Install packaging dependencies
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -y \
-            python3 python3-dev python3-pip python3-venv python3-all \
-            dh-python debhelper devscripts dput software-properties-common \
-            python3-distutils python3-setuptools python3-wheel python3-stdeb \
-            python3-all
+      - name: Install Debian Package Building Dependencies
+        run: sudo bash debian/install_pkg_build_deps.sh
 
-      - name: Build Debian/Apt sdist_dsc
-        run: |
-          python3 -m pip install .
-          rm -Rf deb_dist/*
-          python3 setup.py --command-packages=stdeb.command sdist_dsc
+      - name: Create Debian Package
+        run: make clean package
 
-      - name: Build Debian/Apt bdist_deb
-        run: |
-          python3 -m pip install .
-          export REPO_NAME=$(echo ${{ github.repository }} | awk -F"/" '{print $2}')
-          python3 setup.py --command-packages=stdeb.command bdist_deb
-          ls -al deb_dist/
-          cp deb_dist/python3-${REPO_NAME}_*_all.deb deb_dist/python3-${REPO_NAME}_latest_all.deb
-
-      - uses: actions/upload-artifact@master
+      - name: Upload Artifacts to GitHub
+        uses: actions/upload-artifact@master
         with:
           name: artifact-deb
-          path: |
-            deb_dist/*.deb
+          path: deb_dist/*.deb
 
-      - name: Create Release
+      - name: Create GitHub Release
         id: create_release
         uses: actions/create-release@master
         env:
@@ -55,7 +38,7 @@ jobs:
           draft: false
           prerelease: false
 
-      - name: Upload Release Asset
+      - name: Upload Release Asset to GitHub
         id: upload-release-asset
         uses: svenstaro/upload-release-action@v2
         with:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## AirCOT 3.0.0
+
+Happy Summer Solstice
+
+
 ## AirCOT 2.0.0
 
 - New for 2024!

diff --git a/Makefile b/Makefile
@@ -1,11 +1,11 @@
+# Makefile from https://github.com/snstac/pytak
+# PyTAK Makefile
 #
-# Copyright Sensors & Signals LLC https://www.snstac.com
+# Copyright Sensors & Signals LLC https://www.snstac.com/
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,10 +14,14 @@
 # limitations under the License.
 #
 
-this_app = aircot
-.DEFAULT_GOAL := all
+REPO_NAME ?= $(shell echo $(wildcard */__init__.py) | awk -F'/' '{print $$1}')
+SHELL := /bin/bash
+.DEFAULT_GOAL := editable
+# postinst = $(wildcard debian/*.postinst.sh)
+# service = $(wildcard debian/*.service)
 
-all: editable
+prepare:
+	mkdir -p build/
 
 develop:
 	python3 setup.py develop
@@ -26,13 +30,13 @@ editable:
 	python3 -m pip install -e .
 
 install_test_requirements:
-	python3 -m pip install -r requirements_test.txt
+	python3 -m pip install -r requirements_test.txt 
 
 install:
 	python3 setup.py install
 
 uninstall:
-	python3 -m pip uninstall -y $(this_app)
+	python3 -m pip uninstall -y $(REPO_NAME)
 
 reinstall: uninstall install
 
@@ -43,16 +47,16 @@ clean:
 	@rm -rf *.egg* build dist *.py[oc] */*.py[co] cover doctest_pypi.cfg \
 		nosetests.xml pylint.log output.xml flake8.log tests.log \
 		test-result.xml htmlcov fab.log .coverage __pycache__ \
-		*/__pycache__
+		*/__pycache__ deb_dist .mypy_cache
 
 pep8:
-	flake8 --max-line-length=88 --extend-ignore=E203 --exit-zero $(this_app)/*.py
+	flake8 --max-line-length=88 --extend-ignore=E203 --exit-zero $(REPO_NAME)/*.py
 
 flake8: pep8
 
 lint:
 	pylint --msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}" \
-		--max-line-length=88 -r n $(this_app)/*.py || exit 0
+		--max-line-length=88 -r n $(REPO_NAME)/*.py || exit 0
 
 pylint: lint
 
@@ -68,11 +72,32 @@ pytest:
 test: editable install_test_requirements pytest
 
 test_cov:
-	pytest --cov=$(this_app) --cov-report term-missing
+	pytest --cov=$(REPO_NAME) --cov-report term-missing
 
 black:
 	black .
 
 mkdocs:
 	pip install -r docs/requirements.txt
-	mkdocs serve
+	mkdocs serve
+
+deb_dist: 
+	python3 setup.py --command-packages=stdeb.command sdist_dsc
+
+deb_custom:
+	cp debian/$(REPO_NAME).conf $(wildcard deb_dist/*/debian)/$(REPO_NAME).default
+	cp debian/$(REPO_NAME).postinst $(wildcard deb_dist/*/debian)/$(REPO_NAME).postinst
+	cp debian/$(REPO_NAME).service $(wildcard deb_dist/*/debian)/$(REPO_NAME).service
+
+bdist_deb: deb_dist deb_custom
+	cd deb_dist/$(REPO_NAME)-*/ && dpkg-buildpackage -rfakeroot -uc -us
+
+faux_latest:
+	cp deb_dist/$(REPO_NAME)_*-1_all.deb deb_dist/$(REPO_NAME)_latest_all.deb
+	cp deb_dist/$(REPO_NAME)_*-1_all.deb deb_dist/python3-$(REPO_NAME)_latest_all.deb
+
+package: bdist_deb faux_latest
+
+extract: 
+	dpkg-deb -e $(wildcard deb_dist/*latest_all.deb) deb_dist/extract
+	dpkg-deb -x $(wildcard deb_dist/*latest_all.deb) deb_dist/extract
diff --git a/README.rst → README.md b/README.rst → README.md
@@ -1,20 +1,18 @@
-.. image:: https://pytak.readthedocs.io/en/latest/atak_screenshot_with_pytak_logo-x25.jpg
-   :alt: ATAK Screenshot with PyTAK Logo.
+![ATAK screenshot with PyTAK logo.](https://aircot.readthedocs.io/en/latest/media/atak_screenshot_with_pytak_logo-x25.png)
 
-Classify aircraft in TAK
-************************
+# Classify aircraft in TAK
 
 AirCOT is software for classifying aircraft within the Team Awareness Kit (TAK) ecosystem of products.
 
 AirCOT is used by these TAK compatible products:
 
-1. `adsbcot <https://github.com/snstac/adsbcot>`_: ADSBCOT is software for monitoring and analyzing aviation surveillance data via the Team Awareness Kit (TAK) ecosystem of products.
-2. `AirTAK <https://www.snstac.com/airtak>`_: AirTAK is a low SWaP-C device for monitoring and analyzing aviation surveillance data via the Team Awareness Kit (TAK) ecosystem of products. 
+1. [ADSBCOT](https://github.com/snstac/adsbcot) is software for monitoring and analyzing aviation surveillance data via the Team Awareness Kit (TAK) ecosystem of products.
+2. [AirTAK](https://www.snstac.com/airtak) is a low SWaP-C device for monitoring and analyzing aviation surveillance data via the Team Awareness Kit (TAK) ecosystem of products. 
 
-`Documentation is available here. <https://aircot.rtfd.io>`_
+[Documentation is available here](https://aircot.rtfd.io)
+
+## Copyright & License
 
-License
-=======
 Copyright Sensors & Signals LLC https://www.snstac.com
 
 Licensed under the Apache License, Version 2.0 (the "License");

diff --git a/aircot/__init__.py b/aircot/__init__.py
@@ -16,17 +16,11 @@
 # limitations under the License.
 #
 
-"""Aircraft classifier for TAK.
+"""Aircraft classifier for TAK."""
 
-:source: <https://github.com/snstac/aircot>
-"""
+__version__ = "3.0.0-beta1"
 
-__version__ = "2.0.0"
-__author__ = "Greg Albrecht <gba@snstac.com>"
-__copyright__ = "Copyright Sensors & Signals LLC https://www.snstac.com"
-__license__ = "Apache License, Version 2.0"
-
-# Python 3.6 test/build work-around:
+# COMPAT Python 3.6 test/build work-around:
 try:
     from .constants import (  # NOQA
         LOG_FORMAT,
@@ -67,5 +61,4 @@
 except ImportError as exc:
     import warnings
 
-    warnings.warn(str(exc))
-    warnings.warn("ADSBCOT ignoring ImportError - Python 3.6 compat work-around.")
+    warnings.warn(f"COMPAT Python 3.6. Ignoring {str(exc)}")
diff --git a/aircot/constants.py b/aircot/constants.py
@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+# constants.py from https://github.com/snstac/aircot
 #
 # Copyright Sensors & Signals LLC https://www.snstac.com
 #
@@ -20,10 +21,6 @@
 import logging
 import os
 
-__author__ = "Greg Albrecht <gba@snstac.com>"
-__copyright__ = "Copyright Sensors & Signals LLC https://www.snstac.com"
-__license__ = "Apache License, Version 2.0"
-
 LOG_LEVEL: int = logging.INFO
 LOG_FORMAT: logging.Formatter = logging.Formatter(
     ("%(asctime)s aircot %(levelname)s - %(message)s")
@@ -43,7 +40,7 @@
 DEFAULT_COT_VAL: str = "9999999.0"
 
 W3C_XML_DATETIME: str = "%Y-%m-%dT%H:%M:%S.%fZ"
-ISO_8601_UTC = W3C_XML_DATETIME  # Issue 51: Not technically correct.
+ISO_8601_UTC: str = "%Y-%m-%dT%H:%M:%SZ"
 
 DEFAULT_ADSB_ID_DB: str = "cotdb_indexed.json"
 

diff --git a/aircot/functions.py b/aircot/functions.py
@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+# constants.py from https://github.com/snstac/aircot
 #
 # Copyright Sensors & Signals LLC https://www.snstac.com
 #

diff --git a/debian/aircot.conf b/debian/aircot.conf
diff --git a/debian/aircot.postinst b/debian/aircot.postinst
diff --git a/debian/aircot.service b/debian/aircot.service
diff --git a/debian/install_pkg_build_deps.sh b/debian/install_pkg_build_deps.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo "Installing Debian package build dependencies"
+
+apt-get update -qq
+
+apt-get install -y \
+  python3 python3-dev python3-pip python3-venv python3-all \
+  dh-python debhelper devscripts dput software-properties-common \
+  python3-distutils python3-setuptools python3-wheel python3-stdeb
diff --git a/docs/atak_screenshot_with_pytak_logo-x25.png → ...a/atak_screenshot_with_pytak_logo-x25.png b/docs/atak_screenshot_with_pytak_logo-x25.png → ...a/atak_screenshot_with_pytak_logo-x25.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: AirCOT - Aircraft classifiers for TAK
+site_name: Aircraft classifiers for TAK
 site_url: https://aircot.rtfd.io/
 repo_url: https://github.com/snstac/aircot/
 site_description: Software for classifying aircraft within the Team Awareness Kit (TAK) ecosystem of products.

diff --git a/setup.cfg b/setup.cfg
@@ -23,9 +23,9 @@ project_urls =
   CI: GitHub Actions = https://github.com/snstac/aircot/actions
   GitHub: issues = https://github.com/snstac/aircot/issues
   GitHub: repo = https://github.com/snstac/aircot
-description = Software for classifying aircraft within the Team Awareness Kit (TAK) ecosystem of products.
-long_description = file: README.rst
-long_description_content_type = text/x-rst
+description = Software for classifying aircraft within TAK.
+long_description = file: README.md
+long_description_content_type = text/markdown
 maintainer = Greg Albrecht <oss@undef.net>
 maintainer_email = oss@undef.net
 license = Apache 2.0

diff --git a/setup.py b/setup.py
@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+# setup.py from https://github.com/snstac/aircot
 #
 # Copyright Sensors & Signals LLC https://www.snstac.com
 #
@@ -16,10 +17,7 @@
 # limitations under the License.
 #
 
-"""Setup for AirCOT.
-
-:source: <https://github.com/snstac/aircot>
-"""
+"""Setup for AirCOT."""
 
 from setuptools import setup
 

diff --git a/stdeb.cfg b/stdeb.cfg
@@ -0,0 +1,3 @@
+[DEFAULT]
+Package3: aircot
+Replaces3: python3-aircot