python -m venv nomnomdata
source nomnomdata/bin/activate

pip install nomnomdata-tools-engine nomnomdata-engine

nnd engine-tools create-new tutorial

.
└── tutorial
    ├── Dockerfile
    ├── main.py
    ├── requirements.txt
    └── pkg
        ├── __init__.py
        ├── executable.py
        └── tests
            ├── __init__.py
            └── test_executable.py

      nomnomdata-engine>=0.5.2

      FROM registry.gitlab.com/nomnomdata/tools/nomnomdata-engine:latest as builder

      COPY requirements.txt /nomnom/requirements.txt
      RUN pip wheel --wheel-dir /python_packages -r /nomnom/requirements.txt

      FROM registry.gitlab.com/nomnomdata/tools/nomnomdata-engine:latest-slim

      COPY --from=builder /python_packages /python_packages
      RUN pip install --no-index --find-links /python_packages /python_packages/* \
            && rm -rf /python_packages 

      WORKDIR /nomnom/
      COPY main.py /nomnom/
      COPY pkg/*.* /nomnom/pkg/

      CMD python main.py run

      # Hello World Sample

      Hello World Sample demonstrates basic app structure and functionality.

      ## Hello World

      The Hello World action will cause the words Hello World or Hello 'Name', 
      where 'Name' is a string specified, to be printed in the Task execution
      log the number of times specified.

      ### Repeat

      Enter the number of times that Hello World or Hello <Name> should be printed.

      ### Name

      Enter a name that should be printed after Hello instead of World.

      import logging

      from nomnomdata.engine.components import Engine, Parameter, ParameterGroup
      from nomnomdata.engine.parameters import Int, String

      logger = logging.getLogger("engine.hello_world")

      engine = Engine(
            uuid="CHANGE-ME-PLEASE",
            alias="Hello World Sample",
            description="Demonstrates basic app structure and functionality.",
            categories=["general"],
      )

      engine = Engine(
            uuid="YOUR-UNIQUEID",
            alias="Hello World",
            description="Demonstrates basic app structure and functionality.",
            categories=["general"],
            icons={
                  "1x": "icons/icon-1x.png",
                  "2x": "icons/icon-2x.png",
                  "3x": "icons/icon-3x.png",
            },
      )

      @engine.action(
            display_name="Hello World",
            description="Prints a greeting multiple times in the Task execution log.",
      )

      @engine.action(
            display_name="Hello World",
            description="Prints a greeting multiple times in the Task execution log.",
            help_md_path="help/help.md",
      )

      @engine.parameter_group(
            name="general_parameters",
            display_name="General Parameters",
            description="Parameters for Hello World",
            parameter_group=ParameterGroup(
                  Parameter(
                        type=Int(),
                        name="repeat",
                        display_name="Repeat",
                        description="Specify how many times to print.",
                        default=1,
                        required=True,
                  ),
                  Parameter(
                        type=String(),
                        name="name",
                        display_name="Name",
                        description="Specify a name to print instead of World.",
                        required=False,
                  ),
            ),
      )

def hello_world(parameters):
            i = 0
            x = f"Hello {parameters.get('name') or 'World'}"
            while i < parameters["repeat"]:
                  logger.info(x)
                  i += 1
            return i, x

      from ..executable import hello_world

      def test_hello_world_no_name():
            args = {"repeat": 1}
            api_calls, results = hello_world(**args)
            assert results == (args["repeat"], f"Hello World")

      def test_hello_world_with_name():
            args = {"repeat": 3, "name": "Joe"}
            api_calls, results = hello_world(**args)
            assert results == (args["repeat"], f"Hello Joe")

Deploy and Publish Your Nom Nom App

python main.py dump-yaml

nnd login

A token will automatically be generated when you log in and it will be valid for 30 days.  If you are following these steps multiple times, you only need to do this step if it has been more than 30 days since your last login.

nnd engine-tools model-update -c stable

nnd engine-tools deploy -c stable

If you receive this error after executing the command:

docker.errors.DockerException: Error while fetching server API version:

(2, 'CreateFile', 'The system cannot find the file specified.')

Ensure that Docker Desktop / Docker for Linux has been launched and is running successfully.

On Windows, if you received this error after executing the command:

docker.errors.DockerException: Install pypiwin32 package to enable npipe:// support

Try running this command to resolve the error:

python <path-to-python-installation>\Scripts\pywin32_postinstall.py -install

Developer Portal