Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robinjhuang committed Dec 29, 2024
1 parent 5adab71 commit 66a6f93
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,10 @@

The resulting ComfyUI node extension project will automatically come with a few neat features:

- Support for Ruff linter
- Support for Ruff linter and various recommended rules
- A pre-commit hook for the Ruff linter
- An `entry_point` that will ensure that ComfyUI can load your extension regardless of how it's installed
- An optional `web` directory if your extension will include custom javascript
- If selected, `web` will also be added to the project's `MANIFEST.in` to ensure that any non-python code in `web` will also be correctly installed

In progress (still needs a little work):
- Testing via PyTest, including a basic integration/sanity check
- A git action that will automatically run any tests as part of Pull Requests made against your project
- Testing via PyTest (check the `tests/` directory)
- A Github Action that will automatically run any tests as part of Pull Requests made against your project
- A Github Action to publish to the Comfy Registry
3 changes: 3 additions & 0 deletions {{cookiecutter.project_name}}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ target-version = "py39"
select = [
"S102", # exec-builtin
"S307", # eval-used
"W293",
"F", # The "F" series in Ruff stands for "Pyflakes" rules, which catch various Python syntax errors and undefined names.
# See all rules here: https://docs.astral.sh/ruff/rules/#pyflakes-f
]

[tool.ruff.lint.flake8-quotes]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def INPUT_TYPES(s):
"""
return {
"required": {
"image": ("IMAGE",),
"image": ("IMAGE", { "tooltip": "This is an image"}),
"int_field": ("INT", {
"default": 0,
"min": 0, #Minimum value
Expand All @@ -73,10 +73,11 @@ def INPUT_TYPES(s):

RETURN_TYPES = ("IMAGE",)
#RETURN_NAMES = ("image_output_name",)

DESCRIPTION = "This is an example node"
FUNCTION = "test"

#OUTPUT_NODE = False
#OUTPUT_TOOLTIPS = ("",) # Tooltips for the output node

CATEGORY = "Example"

Expand Down

0 comments on commit 66a6f93

Please sign in to comment.