From 51d6d8312c54224b338fe83a5ea762b4d2d0c154 Mon Sep 17 00:00:00 2001 From: Julian Kimmig Date: Tue, 13 Jan 2026 09:34:08 +0100 Subject: [PATCH 1/3] fix(tests): correct typo in test function name for clarity Renamed the test function from `test_config_not_laoded` to `test_config_not_loaded` to fix a typo and improve readability. --- tests/test_config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_config.py b/tests/test_config.py index 90db9da..aa5c5ce 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -42,7 +42,7 @@ def test_no_deprecation_warning(): warnings.simplefilter("error", DeprecationWarning) -def test_config_not_laoded(): +def test_config_not_loaded(): try: assert not fn.config._CONFIG_CHANGED, "Expected _CONFIG_CHANGED to be False" From ef5b7004d98be98131d5f1a1d27650dd0cf6a230 Mon Sep 17 00:00:00 2001 From: Julian Kimmig Date: Thu, 15 Jan 2026 18:42:51 +0100 Subject: [PATCH 2/3] docs: add contributing guide and expand README Add CONTRIBUTING.md with local uv-based setup instructions and clarify installation and documentation links in the README. --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 27 +++++++++++++++++++++++++-- 2 files changed, 74 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f7caeab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to funcnodes-core + +This repository contains the **core runtime** (nodes, IO, nodespace, library, config, serialization). + +## Development setup (Python) + +Prereqs: + +- Python **3.11+** +- `uv` (https://github.com/astral-sh/uv) + +Recommended environment variables (keep caches/config local): + +- `UV_CACHE_DIR=.cache/uv` +- `FUNCNODES_CONFIG_DIR=.funcnodes` + +Install dev dependencies: + +```bash +cd funcnodes_core +UV_CACHE_DIR=.cache/uv uv sync --group dev +``` + +Run tests: + +```bash +cd funcnodes_core +FUNCNODES_CONFIG_DIR=.funcnodes UV_CACHE_DIR=.cache/uv uv run pytest +``` + +## Code style & hooks + +Run pre-commit: + +```bash +cd funcnodes_core +UV_CACHE_DIR=.cache/uv uv run pre-commit install +UV_CACHE_DIR=.cache/uv uv run pre-commit run -a +``` + +## TDD expectations + +- Write tests first; add edge cases as separate tests. +- Avoid mocks unless simulating external resources. + +## Pull requests + +- Work on a feature branch (direct commits to `main`/`master`/`test` are blocked by pre-commit). +- Keep changes scoped: core is widely used across FuncNodes packages. diff --git a/README.md b/README.md index 2118fee..231857f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -Core package for funcnodes. -for detailed instructions go to the funcnodes repo +# FuncNodes Core + +This is the core package for **FuncNodes**, a flexible and modular framework for building and managing computational graphs. + +`funcnodes_core` contains the fundamental logic for Nodes, NodeSpaces, and the event-driven architecture that powers the system. + +> [!NOTE] +> If you are looking for the full application, including the web interface and worker management, please visit the main [FuncNodes repository](https://github.com/Linkdlab/FuncNodes) or install the `funcnodes` package. + +## Installation + +If you are developing a custom implementation or only need the core logic: + +```bash +pip install funcnodes-core +``` + +For the full experience: +```bash +pip install funcnodes +``` + +## Documentation + +For detailed instructions and documentation, please visit the [FuncNodes Documentation](https://linkdlab.github.io/FuncNodes). From 1989d21ffc0c6761f619b249b0bafced131dd72e Mon Sep 17 00:00:00 2001 From: JulianKimmig Date: Fri, 16 Jan 2026 09:41:10 +0100 Subject: [PATCH 3/3] feat(context): add context7 configuration file with URL and public key --- context7.json | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 context7.json diff --git a/context7.json b/context7.json new file mode 100644 index 0000000..f6297ed --- /dev/null +++ b/context7.json @@ -0,0 +1,4 @@ +{ + "url": "https://context7.com/linkdlab/funcnodes_core", + "public_key": "pk_jr5hlTznUKh2bFkliKxXR" + } \ No newline at end of file