From d8495dc8787276bf5c7aa26bf21ea05500c73779 Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 16:37:10 +0000 Subject: [PATCH 1/8] Update README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 4cb60ad..afc61cd 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,26 @@ It has 4 standard entry points, defined in `pyproject.toml`: It has a Forgejo CI build action, defined in `.forgejo/actions/build.yaml`. +## Usage + +```fish +set NAME knoc_foo +set DNAME (echo $NAME | tr "_" "-") +``` + +or with bash: +```bash +NAME=knoc_foo +DNAME=$(echo $NAME | tr "_" "-") +``` + +Then: +```fish +git clone https://code.philo.ydns.eu/K-Net/knoc-plugin-template.git $NAME +cd $NAME +rm -rf .git +mv src/knoc_plugin_template src/$NAME +sed "s/knoc_plugin_template/$NAME/" -i pyproject.toml +sed "s/knoc-plugin-template/$DNAME/" -i pyproject.toml + +``` From 1e51db31702157d33ffae6b92f836e5d6dadb6cc Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 16:45:19 +0000 Subject: [PATCH 2/8] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index afc61cd..a34efe7 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,14 @@ DNAME=$(echo $NAME | tr "_" "-") Then: ```fish -git clone https://code.philo.ydns.eu/K-Net/knoc-plugin-template.git $NAME -cd $NAME +git clone https://code.philo.ydns.eu/K-Net/knoc-plugin-template.git $DNAME +cd $DNAME rm -rf .git mv src/knoc_plugin_template src/$NAME sed "s/knoc_plugin_template/$NAME/" -i pyproject.toml sed "s/knoc-plugin-template/$DNAME/" -i pyproject.toml - +sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/api.py +sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/cli.py +sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/settings.py +sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/workflows.py ``` From e8d64c3b80307b3e3d81ad33c555fd03f73902ff Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 17:01:04 +0000 Subject: [PATCH 3/8] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a34efe7..65b2e28 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,18 @@ It has a Forgejo CI build action, defined in `.forgejo/actions/build.yaml`. ## Usage +Just replace `foo` by the name of the plugin below: + ```fish -set NAME knoc_foo +set NAME foo +set PNAME knoc_$NAME set DNAME (echo $NAME | tr "_" "-") ``` or with bash: ```bash NAME=knoc_foo +PNAME=knoc_$NAME DNAME=$(echo $NAME | tr "_" "-") ``` @@ -32,10 +36,10 @@ git clone https://code.philo.ydns.eu/K-Net/knoc-plugin-template.git $DNAME cd $DNAME rm -rf .git mv src/knoc_plugin_template src/$NAME -sed "s/knoc_plugin_template/$NAME/" -i pyproject.toml +sed "s/plugin_template/$NAME/" -i pyproject.toml sed "s/knoc-plugin-template/$DNAME/" -i pyproject.toml -sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/api.py -sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/cli.py -sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/settings.py -sed "s/knoc_plugin_template/$NAME/" -i src/$NAME/workflows.py +sed "s/plugin_template/$NAME/" -i src/$NAME/api.py +sed "s/plugin_template/$NAME/" -i src/$NAME/cli.py +sed "s/plugin_template/$NAME/" -i src/$NAME/settings.py +sed "s/plugin_template/$NAME/" -i src/$NAME/workflows.py ``` From 21a08142cf29d2e3206ba77e1d4ae657c21bc509 Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 17:01:23 +0000 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65b2e28..86f587d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ set DNAME (echo $NAME | tr "_" "-") or with bash: ```bash -NAME=knoc_foo +NAME=foo PNAME=knoc_$NAME DNAME=$(echo $NAME | tr "_" "-") ``` From a9bc70650179daff2562565ffe83e48da5d88112 Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 17:03:52 +0000 Subject: [PATCH 5/8] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86f587d..4c21162 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,9 @@ rm -rf .git mv src/knoc_plugin_template src/$NAME sed "s/plugin_template/$NAME/" -i pyproject.toml sed "s/knoc-plugin-template/$DNAME/" -i pyproject.toml -sed "s/plugin_template/$NAME/" -i src/$NAME/api.py -sed "s/plugin_template/$NAME/" -i src/$NAME/cli.py -sed "s/plugin_template/$NAME/" -i src/$NAME/settings.py -sed "s/plugin_template/$NAME/" -i src/$NAME/workflows.py +sed "s/plugin_template/$NAME/" -i src/$PNAME/api.py +sed "s/plugin_template/$NAME/" -i src/$PNAME/cli.py +sed "s/plugin_template/$NAME/" -i src/$PNAME/settings.py +sed "s/plugin_template/$NAME/" -i src/$PNAME/workflows.py +uv venv ``` From a8a649964d925d16a9bca4b113989a6d9c40cba9 Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 17:11:44 +0000 Subject: [PATCH 6/8] Update README.md --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c21162..e4ec856 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ It has a Forgejo CI build action, defined in `.forgejo/actions/build.yaml`. ## Usage -Just replace `foo` by the name of the plugin below: +Just replace `foo` by the name of the plugin below. + +With `fish`: ```fish set NAME foo @@ -43,4 +45,25 @@ sed "s/plugin_template/$NAME/" -i src/$PNAME/cli.py sed "s/plugin_template/$NAME/" -i src/$PNAME/settings.py sed "s/plugin_template/$NAME/" -i src/$PNAME/workflows.py uv venv +git init ``` + +Then, with `fish`: +```fish +. .venv/bin/activate.fish +uv sync +``` + +Or `bash`: +```bash +. .venv/bin/activate +uv sync +``` + +The package is ready. + +In a *knoc* development environment: +```fish +uv pip install -e ../$DNAME +knoc # Should display the new plugin's CLI tool +``` \ No newline at end of file From 8eb40f6080a36a49f5b39bb47f4ca6a90969342b Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 17:13:26 +0000 Subject: [PATCH 7/8] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e4ec856..75e8e6f 100644 --- a/README.md +++ b/README.md @@ -60,10 +60,12 @@ Or `bash`: uv sync ``` -The package is ready. +=> The package is ready. In a *knoc* development environment: ```fish uv pip install -e ../$DNAME knoc # Should display the new plugin's CLI tool -``` \ No newline at end of file +``` + +Finally, set the git upstream, edit, commit, tag, push. \ No newline at end of file From e44445abbd371ab16a72fc7e0aa0ae67921fdca7 Mon Sep 17 00:00:00 2001 From: phil Date: Wed, 28 May 2025 17:14:51 +0000 Subject: [PATCH 8/8] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75e8e6f..176112d 100644 --- a/README.md +++ b/README.md @@ -68,4 +68,6 @@ uv pip install -e ../$DNAME knoc # Should display the new plugin's CLI tool ``` -Finally, set the git upstream, edit, commit, tag, push. \ No newline at end of file +Finally, set the git upstream, edit, commit, tag, push. + +To add the plugin in a production image, add the name to the `PLUGIN` variable of the CI build tool, and deploy. \ No newline at end of file