added renovate, versioning and GPL v3 license

Author: netnutmike

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .
+    
+    - name: Run unit tests
+      run: |
+        python -m unittest discover tests -v -k "not test_e2e"
+    
+    - name: Run end-to-end tests
+      run: |
+        python -m unittest tests.test_e2e -v
+      continue-on-error: true  # E2E tests may fail due to network issues

CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-11-16
+
+### Added
+- Initial release of meshtastic-mqtt-protobuf CLI tool
+- Licensed under GNU General Public License v3.0 or later (GPL-3.0-or-later)
+- Command-line interface for sending protobuf-encoded messages to Meshtastic MQTT servers
+- Support for broadcast and direct messaging
+- Acknowledgment request functionality
+- Configurable hop limit for message propagation
+- YAML configuration file support with CLI argument overrides
+- Comprehensive error handling with specific exit codes
+- Verbose logging mode for debugging
+- Full protobuf compatibility with Meshtastic specification
+- End-to-end tests with actual MQTT broker
+- Protobuf compatibility validation tests
+- Complete documentation in README.md
+
+### Features
+- Connect to any Meshtastic MQTT broker
+- Send text messages using native protobuf format
+- Configure via YAML file or command-line arguments
+- Support for multiple regions and channels
+- Automatic packet ID generation
+- UTF-8 text encoding with Unicode support
+- QoS 1 message delivery for reliability
+
+### Dependencies
+- meshtastic>=2.2.0
+- paho-mqtt>=1.6.1
+- PyYAML>=6.0
+
+## [Unreleased]
+
+### Planned
+- Support for additional message types (position, telemetry)
+- Message subscription and listening capabilities
+- Interactive mode for continuous messaging
+- Message history and logging
+- Configuration validation command
+- Shell completion support
+
+[1.0.0]: https://github.com/yourusername/meshtastic-mqtt-protobuf/releases/tag/v1.0.0

LICENSE

@@ -333,7 +333,18 @@ Contributions are welcome! Please feel free to submit issues or pull requests.
 
 ## License
 
-[Add your license here]
+This project is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).
+
+See the [LICENSE](LICENSE) file for the full license text.
+
+### What this means:
+
+- You are free to use, modify, and distribute this software
+- If you distribute modified versions, you must also license them under GPL v3
+- You must make the source code available when distributing the software
+- There is NO WARRANTY for this software
+
+For more information, visit: https://www.gnu.org/licenses/gpl-3.0.html
 
 ## Acknowledgments
 

README.md

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ],
+  "packageRules": [
+    {
+      "matchDatasources": ["pypi"],
+      "matchUpdateTypes": ["minor", "patch"],
+      "automerge": true,
+      "automergeType": "pr",
+      "automergeStrategy": "squash"
+    },
+    {
+      "matchDatasources": ["pypi"],
+      "matchUpdateTypes": ["major"],
+      "automerge": false
+    }
+  ],
+  "pip_requirements": {
+    "fileMatch": ["^requirements\\.txt$"]
+  },
+  "python": {
+    "enabled": true
+  },
+  "schedule": [
+    "before 6am on monday"
+  ],
+  "timezone": "America/New_York",
+  "labels": ["dependencies"],
+  "assignees": [],
+  "reviewers": [],
+  "prConcurrentLimit": 5,
+  "prHourlyLimit": 2,
+  "vulnerabilityAlerts": {
+    "enabled": true,
+    "labels": ["security"]
+  },
+  "lockFileMaintenance": {
+    "enabled": false
+  }
+}

renovate.json

@@ -2,6 +2,7 @@
 
 from setuptools import setup, find_packages
 from pathlib import Path
+import re
 
 # Read the contents of README file
 this_directory = Path(__file__).parent
@@ -16,27 +17,40 @@
 if requirements_path.exists():
     requirements = requirements_path.read_text(encoding="utf-8").splitlines()
 
+# Read version from __version__.py
+version = "0.1.0"  # fallback
+version_file = this_directory / "src" / "meshtastic_mqtt_protobuf" / "__version__.py"
+if version_file.exists():
+    version_content = version_file.read_text(encoding="utf-8")
+    version_match = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', version_content, re.MULTILINE)
+    if version_match:
+        version = version_match.group(1)
+
 setup(
     name="meshtastic-mqtt-protobuf",
-    version="0.1.0",
+    version=version,
     author="Meshtastic MQTT Protobuf Contributors",
     description="A CLI tool for sending protobuf-encoded messages to Meshtastic MQTT servers",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/yourusername/meshtastic-mqtt-protobuf",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
+    license="GPL-3.0-or-later",
     classifiers=[
-        "Development Status :: 3 - Alpha",
+        "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",
+        "Intended Audience :: End Users/Desktop",
         "Topic :: Communications",
-        "License :: OSI Approved :: MIT License",
+        "Topic :: Communications :: Ham Radio",
+        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
     ],
     python_requires=">=3.7",
     install_requires=requirements,

setup.py

@@ -3,5 +3,7 @@
 A command-line tool for sending protobuf-encoded messages to Meshtastic MQTT servers.
 """
 
-__version__ = "0.1.0"
+from .__version__ import __version__
+
 __author__ = "Meshtastic MQTT Protobuf Contributors"
+__all__ = ['__version__', '__author__']

src/meshtastic_mqtt_protobuf/__init__.py

@@ -0,0 +1,3 @@
+"""Version information for meshtastic-mqtt-protobuf."""
+
+__version__ = "1.0.0"

src/meshtastic_mqtt_protobuf/__version__.py

@@ -1,5 +1,20 @@
 """Command-line interface module for Meshtastic MQTT Protobuf tool.
 
+Copyright (C) 2024 Meshtastic MQTT Protobuf Contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 This module provides the main entry point and orchestration logic for the
 command-line tool. It coordinates configuration loading, message construction,
 MQTT connection, and message publishing.
@@ -44,6 +59,15 @@
 from .mqtt_client import MeshtasticMQTTClient
 
 
+def get_version():
+    """Get the package version."""
+    try:
+        from . import __version__
+        return __version__
+    except ImportError:
+        return "unknown"
+
+
 # Configure logging
 logger = logging.getLogger(__name__)
 
@@ -160,6 +184,12 @@ def parse_arguments():
         help='Enable verbose logging (DEBUG level)'
     )
 
+    parser.add_argument(
+        '--version',
+        action='version',
+        version=f'%(prog)s {get_version()}'
+    )
+    
     return parser.parse_args()
 
 

src/meshtastic_mqtt_protobuf/cli.py

@@ -1,5 +1,20 @@
 """Configuration management module for YAML config files and CLI overrides.
 
+Copyright (C) 2024 Meshtastic MQTT Protobuf Contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 This module handles loading configuration from YAML files, merging with
 command-line argument overrides, and validating required parameters.