Update generic infos

This commit is contained in:
StableLlama
2025-05-07 12:58:29 +02:00
parent 09258231ed
commit 4d2ec80016
2 changed files with 10 additions and 49 deletions
+5 -45
View File
@@ -1,9 +1,11 @@
# Basic data handling
Basic Python functions for manipulating data that every programmer is used to
Basic Python functions for manipulating data that every programmer is used to.
These nodes are very lightweight and require no additional dependencies.
> [!NOTE]
> This projected was created with a [cookiecutter](https://github.com/Comfy-Org/cookiecutter-comfy-extension) template. It helps you start writing custom nodes without worrying about the Python setup.
> This projected is in early development—do not use it in production, yet!
## Quickstart
@@ -14,36 +16,7 @@ Basic Python functions for manipulating data that every programmer is used to
# Features
- A list of features
## Develop
To install the dev dependencies and pre-commit (will run the ruff hook), do:
```bash
cd basic_data_handling
pip install -e .[dev]
pre-commit install
```
The `-e` flag above will result in a "live" install, in the sense that any changes you make to your node extension will automatically be picked up the next time you run ComfyUI.
## Publish to Github
Install Github Desktop or follow these [instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for ssh.
1. Create a Github repository that matches the directory name.
2. Push the files to Git
```
git add .
git commit -m "project scaffolding"
git push
```
## Writing custom nodes
An example custom node is located in [node.py](src/basic_data_handling/nodes.py). To learn more, read the [docs](https://docs.comfy.org/essentials/custom_node_overview).
- STRING: all Python string functions
## Tests
@@ -52,16 +25,3 @@ This repo contains unit tests written in Pytest in the `tests/` directory. It is
- [build-pipeline.yml](.github/workflows/build-pipeline.yml) will run pytest and linter on any open PRs
- [validate.yml](.github/workflows/validate.yml) will run [node-diff](https://github.com/Comfy-Org/node-diff) to check for breaking changes
## Publishing to Registry
If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check that they are correct.
You need to make an account on https://registry.comfy.org and create an API key token.
- [ ] Go to the [registry](https://registry.comfy.org). Login and create a publisher id (everything after the `@` sign on your registry profile).
- [ ] Add the publisher id into the pyproject.toml file.
- [ ] Create an api key on the Registry for publishing from Github. [Instructions](https://docs.comfy.org/registry/publishing#create-an-api-key-for-publishing).
- [ ] Add it to your Github Repository Secrets as `REGISTRY_ACCESS_TOKEN`.
A Github action will run on every git push. You can also run the Github action manually. Full instructions [here](https://docs.comfy.org/registry/publishing). Join our [discord](https://discord.com/invite/comfyorg) if you have any questions!
+5 -4
View File
@@ -4,10 +4,11 @@ build-backend = "setuptools.build_meta"
[project]
name = "basic_data_handling"
version = "0.0.2"
description = "Basic Python functions for manipulating data that every programmer is used to"
version = "0.0.1"
description = """Basic Python functions for manipulating data that every programmer
is used to. Currently supported: STRING."""
authors = [
{name = "Basic data handling", email = "stablellama@tutanota.com"}
{name = "Basic data handling"}
]
readme = "README.md"
license = {text = "MIT license"}
@@ -29,7 +30,7 @@ dev = [
[project.urls]
bugs = "https://github.com/StableLlama/ComfyUI-basic_data_handling/issues"
homepage = "https://github.com/StableLlama/ComfyUI-basic_data_handling"
Repository = "https://github.com/StableLlama/ComfyUI-basic_data_handling"
[tool.comfy]
PublisherId = "stablellama"