initial commit

Author: com4

.editorconfig

@@ -0,0 +1,10 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_size = 4
+max_line_length = 88

.flake8

@@ -0,0 +1,15 @@
+[flake8]
+exclude = .git,__pycache__,.venv
+max-line-length = 88
+import-order-style = google
+application-import-names = MODNAME
+ignore =
+    # Missing docstring for public module
+    D100
+    # Missing docstring for magic method (e.g. __str__)
+    D105
+    # Missing docstring in __init__
+    D107
+per-file-ignores =
+    # Missing docstring in public function
+    tests/*:D103

.gitignore

@@ -0,0 +1,11 @@
+.coverage
+.envrc
+.dir-locals.el
+.projectile
+
+.vscode/**
+
+**/.DS_Store
+**/__pycache__
+**/*.egg-info
+**/.mypy_cache

MODNAME/__init__.py

@@ -0,0 +1,2 @@
+__identifier__ = "MODNAME"
+__version__ = "0.1.0"

MODNAME/node.py

@@ -0,0 +1,46 @@
+import json
+from typing import Any, Optional
+
+from . import __identifier__, __version__
+
+
+async def do_thing(message: dict[str, Any], context: dict[str, Any]) -> dict[str, Any]:
+    """Process some incoming data."""
+    # All debugging information MUST be output in stderr. you can just use the logging
+    # module or if you are a die hard print debugger use this instead:
+    # print("My debug!", file=sys.stderr)
+
+    return message
+
+
+if __name__ == "__main__":
+    import asyncio
+    import sys
+
+    # message is the input to your function. This is the output from the previous
+    # function plus any transformations the user defined in their workflow. Parameters
+    # should be documented in the parameters.json file so they can be used in the UI.
+    try:
+        message = json.loads(sys.argv[1])
+    except IndexError:
+        raise ValueError("missing required `message` argument") from None
+
+    # this contains some contextual information about the workflow and the current
+    # state. required secrets should be defined in the README so users can write their
+    # lookup class with this node's unique requirements in mind.
+    try:
+        context = json.loads(sys.argv[2])
+    except IndexError:
+        raise ValueError("missing `context` argument") from None
+
+    output = asyncio.run(do_thing(message, context))
+
+    # Non-zero exit codes indicate to the executor there was an unrecoverable error and
+    # workflow execution should terminate.
+    if output is None:
+        sys.exit(1)
+
+    # The output of your function is input for a potential next state. It must be in
+    # JSON format and be the only thing output on stdout. This value is picked up by the
+    # executor and processed.
+    print(json.dumps(output))

MODNAME/parameters.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+  }
+}
+

README.md

@@ -0,0 +1,21 @@
+# MODNAME
+This node provides ...
+
+## Node Configuration
+Environment variables can be set to alter functionality.
+
+| name | required | description |
+|-|-|-|
+
+## Context Properities
+The following context properties are available for this node.
+| name | required | description |
+|-|-|-|
+
+## Node1
+This node does the following
+
+### Parameters
+The following parameters are available.
+| name | required | description |
+|-|-|-|

pyproject.toml

@@ -0,0 +1,22 @@
+[tool.black]
+target-version = ["py310"]
+
+[tool.mypy]
+plugins = [
+  "pydantic.mypy"
+]
+
+# follow_imports = "silent"
+# warn_redundant_casts = true
+# warn_unused_ignores = true
+# disallow_any_generics = true
+# check_untyped_defs = true
+# no_implicit_reexport = true
+# for strict mypy: (this is the tricky one :-))
+# disallow_untyped_defs = true
+
+[tool.mypy-pydantic]
+# init_forbid_extra = true
+# init_typed = true
+# warn_required_dynamic_aliases = true
+# warn_untyped_fields = true

setup.cfg

@@ -0,0 +1,45 @@
+[metadata]
+name = MODNAME
+version = attr: MODNAME.__version__
+author = wkflws node developer
+description = "wkflws node - MODNAME"
+# url = https://my-url.com
+# project_urls =
+#     Bug Tracker = https://github.com/myorg/MODNAME/issues/
+#     Source = https://github.com/myorg/MODNAME/
+classifiers =
+    Programming Language :: Python :: 3
+
+[options]
+python_requires = >= 3.10
+packages = find:
+# install_requires =
+
+[options.extras_require]
+testing =
+    # The following libraries are not hosted or distributed.
+    black  # automatic formatter
+    coverage  # unit test coverage analyzer
+    flake8   # style checker
+    flake8-docstrings   # verify docstring formatting
+    flake8-import-order  # verify import order
+    mypy  # static type checker
+    pytest  # unit test discovery and runner
+    pytest-cov  # plugin for the coverage module
+    pytest-mock  # pytest wrapper for mock module
+
+
+# https://coverage.readthedocs.io/en/6.3.2/config.html
+[coverage:run]
+# Measure branch coverage
+branch = True
+# To omit certain files
+# omit = # e.g. src/db/env.py,src/db/versions/*
+# Indicate the directories to evaluate
+source = MODNAME/
+
+[coverage:report]
+# show missing line numbers
+show_missing = True
+# Omit files with 100% coverage from the report
+# skip_covered = True

tests/test_node.py

@@ -0,0 +1,5 @@
+from MODNAME import node
+
+
+def test_do_thing():
+    assert node.do_thing is True