final checkout for v5.0.0

Author: ampledata

.github/workflows/debian.yml

@@ -30,7 +30,7 @@ jobs:
 
       - name: Build Debian/Apt bdist_deb
         run: |
-          export REPO_NAME=$(echo ${github.repository} | awk -F"/" '{print $2}')
+          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

.github/workflows/python-publish_to_pypi.yml

@@ -19,11 +19,11 @@ jobs:
         python-version: '3.x'
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        python3 -m pip install --upgrade pip
+        python3 -m pip install setuptools wheel twine
     - name: Build
       run: |
-        python setup.py sdist bdist_wheel
+        python3 setup.py sdist bdist_wheel
     - name: Publish package
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

.github/workflows/python-test_and_lint.yml

@@ -21,16 +21,18 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Install test requirements
+      run: |
+        make install_test_requirements
+    - name: Install package itself (editable)
       run: |
-        make install_test
         make editable
     - name: Lint with pylint
       run: |
         make pylint
     - name: Lint with flake8
       run: |
         make flake8
-    - name: Test with pytest
+    - name: Test with pytest-cov
       run: |
         make test_cov

.gitignore

@@ -1,3 +1,4 @@
+.vscode/
 *.deb
 *.egg
 *.egg-info/
@@ -29,5 +30,4 @@ output.xml
 pylint.log
 redis-server.log
 redis-server/
-.python-version
 __pycache__

LICENSE

@@ -2,9 +2,7 @@ Copyright 2022 Greg Albrecht <[email protected]>
 
 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,

Makefile

@@ -18,40 +18,37 @@
 # License:: Apache License, Version 2.0
 #
 
-this_app = "aiscot"
+this_app = aiscot
 .DEFAULT_GOAL := all
 
-all: develop
-
-install_requirements:
-	pip install -r requirements_test.txt
+all: editable
 
 develop:
-	python setup.py develop
+	python3 setup.py develop
 
 editable:
-	pip install -e .
+	python3 -m pip install -e .
 
-install_test:
-	pip install -r requirements_test.txt
+install_test_requirements:
+	python3 -m pip install -r requirements_test.txt
 
 install:
-	python setup.py install
+	python3 setup.py install
 
 uninstall:
-	pip uninstall -y adsbxcot
+	python3 -m pip uninstall -y $(this_app)
 
 reinstall: uninstall install
 
+publish:
+	python3 setup.py publish
+
 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__
 
-publish:
-	python setup.py publish
-
 pep8:
 	flake8 --max-line-length=88 --extend-ignore=E203 --exit-zero $(this_app)/*.py
 
@@ -64,15 +61,15 @@ lint:
 pylint: lint
 
 checkmetadata:
-	python setup.py check -s --restructuredtext
+	python3 setup.py check -s --restructuredtext
 
 mypy:
 	mypy --strict .
 
 pytest:
 	pytest
 
-test: editable install_test pytest
+test: editable install_test_requirements pytest
 
 test_cov:
 	pytest --cov=$(this_app)

README.rst

@@ -5,8 +5,6 @@ aiscot - AIS Cursor-on-Target Gateway.
    :alt: Screenshot of AIS as COT PLI in ATAK.
    :target: https://raw.githubusercontent.com/ampledata/aiscot/main/docs/screenshot-1601068921.png
 
-**Tech Support**: Email: [email protected] or Signal/WhatsApp: +1-310-621-9598
-
 AISCOT transforms AIS data to Cursor-On-Target for display on Situational Awareness 
 applications like ATAK, WinTAK, iTAK, TAKX, COPERS, et al. See https://www.tak.gov/ 
 for more information on the TAK program.
@@ -40,24 +38,25 @@ forwarded to AISCOT to be transformed to COT and transmitted to COT destinations
 Receive AIS data from the `AISHUB <https://www.aishub.com>`_ service. 
 Requires a subscription to AISHUB.
 
-Support AISCOT Development
-==========================
+Support Development
+===================
+
+**Tech Support**: Email [email protected] or Signal/WhatsApp: +1-310-621-9598
 
-AISCOT has been developed for the Disaster Response, Public Safety and 
-Frontline community at-large. This software is currently provided at no-cost to 
-our end-users. Any contribution you can make to further these software development 
-efforts, and the mission of AISCOT to provide ongoing SA capabilities to our 
-end-users, is greatly appreciated:
+This tool has been developed for the Disaster Response, Public Safety and
+Frontline Healthcare community. This software is currently provided at no-cost
+to users. Any contribution you can make to further this project's development
+efforts is greatly appreciated.
 
 .. image:: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
     :target: https://www.buymeacoffee.com/ampledata
-    :alt: Support AISCOT development: Buy me a coffee!
+    :alt: Support Development: Buy me a coffee!
 
 
 Installation
 ============
 
-AISCOT functionality is provided by a command-line tool called `aiscot`, 
+AISCOT functionality is provided by a command-line tool called ``aiscot``, 
 which can be installed several ways.
 
 **AISCOT requires Python 3.6 or above.**
@@ -92,19 +91,19 @@ Command-line options:
       -c CONFIG_FILE, --CONFIG_FILE     If specified, use this config file. Default 'config.ini'.
 
 Configuration options:
-    COT_URL : str,  default: udp://239.2.3.1:6969
+    ``COT_URL`` : str,  default: udp://239.2.3.1:6969
         URL to COT destination. Must be a URL, e.g. ``tcp://1.2.3.4:1234`` or ``tls://...:1234``, etc.
-    AIS_PORT : int, default: 5050
+    ``AIS_PORT`` : int, default: 5050
         AIS UDP Listen Port.
-    COT_STALE : int, default: 3600
+    ``COT_STALE`` : int, default: 3600
         CoT Stale period ("timeout"), in seconds. Default `3600` seconds (1 hour).
-    COT_TYPE : str, default: a-u-S-X-M
+    ``COT_TYPE`` : str, default: a-u-S-X-M
         Override COT Event Type ("marker type").
-    AISHUB_URL : str, optional
+    ``AISHUB_URL`` : str, optional
         AISHUB feed URL. See **AISHUB usage notes** in README below.
-    KNOWN_CRAFT : str, optional
+    ``KNOWN_CRAFT`` : str, optional
         Known Craft hints file. CSV file containing callsign/marker hints.
-    INCLUDE_ALL_CRAFT : bool, optional
+    ``INCLUDE_ALL_CRAFT`` : bool, optional
         If using KNOWN_CRAFT, still include other craft not in our KNOWN_CRAFT list.
 
 See example-config.ini in the source tree for example configuration.

aiscot/__init__.py

@@ -5,9 +5,7 @@
 #
 # 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,
@@ -16,8 +14,6 @@
 # limitations under the License.
 #
 # Author:: Greg Albrecht W2GMD <[email protected]>
-# Copyright:: Copyright 2022 Greg Albrecht
-# License:: Apache License, Version 2.0
 #
 
 """

aiscot/classes.py

@@ -5,9 +5,7 @@
 #
 # 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,
@@ -16,8 +14,6 @@
 # limitations under the License.
 #
 # Author:: Greg Albrecht W2GMD <[email protected]>
-# Copyright:: Copyright 2022 Greg Albrecht
-# License:: Apache License, Version 2.0
 #
 
 """AISCOT Class Definitions."""
@@ -202,7 +198,9 @@ async def run(self, number_of_iterations=-1) -> None:
             async with aiohttp.ClientSession() as session:
                 while 1:
                     await asyncio.sleep(poll_interval)
-                    self._logger.info("Polling every %ss: %s", poll_interval, aishub_url)
+                    self._logger.info(
+                        "Polling every %ss: %s", poll_interval, aishub_url
+                    )
                     await self.get_aishub_feed(session, aishub_url)
         else:
             port: int = int(self.config.get("LISTEN_PORT", aiscot.DEFAULT_LISTEN_PORT))

aiscot/commands.py

@@ -5,9 +5,7 @@
 #
 # 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,
@@ -16,8 +14,6 @@
 # limitations under the License.
 #
 # Author:: Greg Albrecht W2GMD <[email protected]>
-# Copyright:: Copyright 2022 Greg Albrecht
-# License:: Apache License, Version 2.0
 #
 
 """PyTAK Command Line."""
@@ -29,5 +25,10 @@
 __license__ = "Apache License, Version 2.0"
 
 
-# PyTAK CLI tool boilerplate:
-pytak.cli(__name__.split(".")[0])
+def main() -> None:
+    # PyTAK CLI tool boilerplate:
+    pytak.cli(__name__.split(".")[0])
+
+
+if __name__ == "__main__":
+    main()