feat: adds ais-encode (CLI) (#186)

* feat: adds ais-encode (CLI)

* fix: remove wheel and build as runtime requirements

* doc: remove ./ from docstring

* fix: shift had no effect

* chore: updates changelog

* feat: adds test_cli_encode.py

Author: M0r13n

CHANGELOG.txt

@@ -1,6 +1,12 @@
 ====================
  pyais CHANGELOG
 ====================
+-------------------------------------------------------------------------------
+ Version 2.12.0 12 Jul 2025
+-------------------------------------------------------------------------------
+* BREAKING: Renamed pyais/main.py to pyais/ais_decode.py
+  * direct imports from pyais.main will fail
+* added ais-encode as installable CLI tool via pip install
 -------------------------------------------------------------------------------
  Version 2.11.1 30 Jun 2025
 -------------------------------------------------------------------------------

Makefile

@@ -24,7 +24,7 @@ clean:
 	rm -f .coverage
 
 ensure-no-print:
-	grep -r --exclude main.py --exclude '*.pyc' -i 'print(' ./pyais && (echo "Debug print statement found"; exit 1)||true
+	grep -r --exclude ais_encode.py --exclude ais_decode.py --exclude '*.pyc' -i 'print(' ./pyais && (echo "Debug print statement found"; exit 1)||true
 
 test: run_tests flake type-check ensure-no-print
 

README.md

@@ -208,7 +208,7 @@ print(encoded)
 
 ### CLI encoder
 
-There is also a AIS JSON to NMEA Encoder: [examples/ais-encode](examples/ais-encode). It reads JSON from stdin and outputs encoded NMEA AIS messages to stdout.
+There is also a AIS JSON to NMEA Encoder for your CLI: `ais-encode`. It reads JSON from stdin and outputs encoded NMEA AIS messages to stdout. Refer to `ais-encode --help`.
 
 # Under the hood
 

pyais/__init__.py

@@ -5,7 +5,7 @@
 from pyais.tracker import AISTracker, AISTrack
 
 __license__ = 'MIT'
-__version__ = '2.11.1'
+__version__ = '2.12.0'
 __author__ = 'Leon Morten Richter'
 
 __all__ = (

pyais/main.py pyais/ais_decode.pypyais/main.py renamed to pyais/ais_decode.py

@@ -14,16 +14,16 @@
 Usage Examples:
 --------------
 1. Encode a single AIS position report:
-   $ echo '{"msg_type":1,"mmsi":231234000,"turn":5.0,"speed":10.1,"lon":5,"lat":59,"course":356.0}' | ./ais-encode
+   $ echo '{"msg_type":1,"mmsi":231234000,"turn":5.0,"speed":10.1,"lon":5,"lat":59,"course":356.0}' | ais-encode
 
 2. Encode multiple messages from line-delimited JSON:
-   $ cat ais_messages.jsonl | ./ais-encode --mode lines
+   $ cat ais_messages.jsonl | ais-encode --mode lines
 
 3. Process a continuous stream of AIS data:
-   $ nc 153.44.253.27 5631 | ais-decode --json | jq -c | ./ais-encode --mode stream
+   $ nc 153.44.253.27 5631 | ais-decode --json | jq -c | ais-encode --mode stream
 
 4. Convert decoded AIS messages back to NMEA:
-   $ ais-decode --json < nmea.txt | ./ais-encode
+   $ ais-decode --json < nmea.txt | ais-encode
 
 Input Format:
 ------------
@@ -72,7 +72,7 @@
 
 
 class AISJSONDecoder(json.JSONDecoder):
-    def __init__(self, *args, **kwargs) -> None:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(object_hook=self._filter_hook, *args, **kwargs)
 
     def _filter_hook(self, obj: Any) -> dict[str, Any]:
@@ -91,6 +91,22 @@ def create_parser() -> argparse.ArgumentParser:
         default='auto',
         help='JSON reading mode'
     )
+
+    parser.add_argument(
+        '--talker',
+        choices=['AIVDM', 'AIVDO',],
+        default='AIVDM',
+        help='AIVDM (default) is used for reports from other ships. AIVDO is used for own ship.',
+        type=str.upper
+    )
+
+    parser.add_argument(
+        '--radio',
+        choices=['A', 'B',],
+        default='A',
+        help='The radio channel. Can be either "A" (default) or "B".',
+        type=str.upper
+    )
     return parser
 
 
@@ -150,7 +166,7 @@ def main() -> int:
         for data in read(args.mode):
             try:
                 # encode NMEA AIS message
-                encoded = encode_dict(data)
+                encoded = encode_dict(data, talker_id=args.talker, radio_channel=args.radio)
             except Exception as e:
                 print(f'Failed to encode: {e}.', file=sys.stderr)
                 continue

examples/ais-encode pyais/ais_encode.pyexamples/ais-encode renamed to pyais/ais_encode.py

@@ -69,7 +69,7 @@ def decode_bin_as_ascii6(bit_arr: bitarray) -> str:
 
         # Last entry may not have 6 bits
         if len(c) != 6:
-            n >> (6 - len(c))
+            n >>= (6 - len(c))
 
         if n < 0x20:
             n += 0x40

pyais/util.py

@@ -43,11 +43,12 @@ dev = ['mypy', 'flake8', 'coverage', 'twine', 'sphinx', 'pytest', 'pytest-cov']
 "Source" = "https://github.com/M0r13n/pyais"
 
 [project.scripts]
-ais-decode = "pyais.main:main"
+ais-decode = "pyais.ais_decode:main"
+ais-encode = "pyais.ais_encode:main"
 
 [tool.setuptools]
 package-data = {"pyais" = ["py.typed"]}
-
+packages = ["pyais"]
 
 [build-system]
 requires = ["setuptools>=43.0.0", "wheel"]

pyproject.toml

@@ -2,7 +2,7 @@
 import sys
 import unittest
 
-from pyais.main import decode_single, decode_from_file, create_parser, decode_from_socket
+from pyais.ais_decode import decode_single, decode_from_file, create_parser, decode_from_socket
 
 
 class TestMainApp(unittest.TestCase):