How to add plugin on Windows

[alexander7567]

Very new to python. Very new :) I am running Windows and I would like to create a plugin. Stating with the ping plugin, I updated it to say Hello instead of Pong. However, when I restart the server, it still responds with Pong. I assume I am missing a step? I don't see anything about HOW to update plugins in the docs.

What am I missing?

[hemna]

Hi Alexander,
Thanks for getting in touch with me. I don't know anything about windows as I use macos and linux full time.

I have a fairly worked through python project creator that creates a base plugin for you and all you have to do is follow the prompts and change your code. Here is an example of me running the cookie cutter.

https://asciinema.org/a/vCHfKxfB7QIVCAWVOLbx6NSQz

1. Install cookiecutter with the command pip install cookiecutter
2. Run cookiecutter with the command cookiecutter gh:hemna/cookiecutter-aprsd-plugin and follow the prompts
3. Edit your new plugin class file and change the "process(self, packet): method to return what you want it to return.
4. install your new plugin with pip install -e . from your plugin's base directory.
5. edit your aprsd.conf to include the full python path to your new plugin in the enabled_plugins line. enabled_plugins = aprsd_myping_plugin.aprsd_myping_plugin.MyPingPlugin
6. start aprsd aprsd server --loglevel DEBUG

You can also simply test your plugin with the dev tool enabled in aprsd after creating your plugin with cookiecutter from the above mentioned steps 1 through 4.

aprsd dev test-plugin -p aprsd_myping_plugin.aprsd_myping_plugin.MyPingPlugin --loglevel DEBUG ping

...
2024-08-14 15:53:02.920 | MainThread         | DEBUG    | ******************************************************************************** | oslo_config.cfg:log_opt_values:2624
2024-08-14 15:53:02.922 | MainThread         | INFO     | Testing plugin <class 'aprsd_myping_plugin.aprsd_myping_plugin.MyPingPlugin'> Version 0.1.0 | aprsd.cmds.dev:test_plugin:112
2024-08-14 15:53:02.923 | MainThread         | INFO     | P'aprsd_myping_plugin.aprsd_myping_plugin.MyPingPlugin'  F'WB4BOR-6'   C'ping' | aprsd.cmds.dev:test_plugin:125
2024-08-14 15:53:02.923 | MainThread         | DEBUG    | MyPingPlugin called | aprsd.plugin:filter:211
2024-08-14 15:53:02.923 | MainThread         | DEBUG    | ==> process: call "{'self': <aprsd_myping_plugin.aprsd_myping_plugin.MyPingPlugin object at 0x106a18460>, 'packet': MessagePacket(_type='MessagePacket', from_call='WB4BOR-6', to_call='WB4BOR-12', addresse=None, format=None, msgNo=1, ackMsgNo=None, packet_type=None, timestamp=1723665183, raw=None, payload=None, path=[], via=None, message_text='ping')}" | aprsd.utils.trace:trace_logging_wrapper:48
2024-08-14 15:53:02.923 | MainThread         | INFO     | MyPingPlugin Plugin | aprsd_myping_plugin.aprsd_myping_plugin:process:61
2024-08-14 15:53:02.923 | MainThread         | DEBUG    | <== process: return (0ms) 'some reply message' | aprsd.utils.trace:trace_logging_wrapper:80
2024-08-14 15:53:02.941 | MainThread         | INFO     | WB4BOR-12>APZ100::WB4BOR-6 :some reply message{5875 | aprsd.cmds.dev:test_plugin:154

My copy of the plugin source from the cookiecutter

└─> cat -p aprsd_myping_plugin/aprsd_myping_plugin.py
import logging

from oslo_config import cfg
from aprsd import packets, plugin, threads, utils
from aprsd.utils import trace

import aprsd_myping_plugin
from aprsd_myping_plugin import conf  # noqa

CONF = cfg.CONF
LOG = logging.getLogger("APRSD")


class MyPingPlugin(plugin.APRSDRegexCommandPluginBase):

    version = aprsd_myping_plugin.__version__
    # Change this regex to match for your plugin's command
    # Tutorial on regex here: https://regexone.com/
    # Look for any command that starts with w or W
    command_regex = "^[pP]"
    # the command is for ?
    # Change this value to a 1 word description of the plugin
    # this string is used for help
    command_name = "ping"

    enabled = False

    def setup(self):
        """Allows the plugin to do some 'setup' type checks in here.

        If the setup checks fail, set the self.enabled = False.  This
        will prevent the plugin from being called when packets are
        received."""
        # Do some checks here?
        self.enabled = True

    def create_threads(self):
        """This allows you to create and return a custom APRSDThread object.

        Create a child of the aprsd.threads.APRSDThread object and return it
        It will automatically get started.

        You can see an example of one here:
        https://github.com/craigerl/aprsd/blob/master/aprsd/threads.py#L141
        """
        if self.enabled:
            # You can create a background APRSDThread object here
            # Just return it for example:
            # https://github.com/hemna/aprsd-weewx-plugin/blob/master/aprsd_weewx_plugin/aprsd_weewx_plugin.py#L42-L50
            #
            return []

    @trace.trace
    def process(self, packet: packets.core.Packet):

        """This is called when a received packet matches self.command_regex.

        This is only called when self.enabled = True and the command_regex
        matches in the contents of the packet["message_text"]."""

        LOG.info("MyPingPlugin Plugin")

        from_callsign = packet.from_call
        message = packet.message_text

        # Now we can process
        return "some reply message"

[alexander7567]

Thank you! This is awesome! Looks like I may have to install Linux however:

INFO:post_gen_project:Remove temporary folder: licenses
Initialized empty Git repository in C:/Ham/cookiecutter/aprsd-foobar-plugin/.git/
[master (root-commit) f892bb6] Initial commit
 24 files changed, 873 insertions(+)
 create mode 100644 .pre-commit-config.yaml
 create mode 100644 LICENSE
 create mode 100644 Makefile
 create mode 100644 README.rst
 create mode 100644 aprsd_foobar_plugin/__init__.py
 create mode 100644 aprsd_foobar_plugin/aprsd_foobar_plugin.py
 create mode 100644 aprsd_foobar_plugin/conf/__init__.py
 create mode 100644 aprsd_foobar_plugin/conf/main.py
 create mode 100644 aprsd_foobar_plugin/conf/opts.py
 create mode 100644 docs/Makefile
 create mode 100644 docs/authors.rst
 create mode 100644 docs/clean_docs.py
 create mode 100644 docs/conf.py
 create mode 100644 docs/contributing.rst
 create mode 100644 docs/history.rst
 create mode 100644 docs/index.rst
 create mode 100644 docs/installation.rst
 create mode 100644 requirements-dev.txt
 create mode 100644 requirements.txt
 create mode 100644 setup.cfg
 create mode 100644 setup.py
 create mode 100644 tests/__init__.py
 create mode 100644 tests/test_aprsd_foobar_plugin.py
 create mode 100644 tox.ini
On branch master
nothing to commit, working tree clean
Traceback (most recent call last):
  File "C:\Users\FIRSTNAME~1.LASTNAME\AppData\Local\Temp\tmp3jwkh1ml.py", line 31, in <module>
    subprocess.call(['pre-commit'])
  File "C:\Python\Lib\subprocess.py", line 389, in call
    with Popen(*popenargs, **kwargs) as p:
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python\Lib\subprocess.py", line 1026, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "C:\Python\Lib\subprocess.py", line 1538, in _execute_child
    hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [WinError 2] The system cannot find the file specified
ERROR: Stopping generation because post_gen_project hook script didn't exit successfully
Hook script failed (exit status: 1)

Also, I failed to say it in my first post, but thank you for this project! It was what I was looking for! (just not linux/python lol, but I will make an attempt anyway :) )