Skip to content
Merged

Test #243

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
4 changes: 4 additions & 0 deletions context7.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"url": "https://context7.com/linkdlab/funcnodes_core",
"public_key": "pk_jr5hlTznUKh2bFkliKxXR"
}
2 changes: 1 addition & 1 deletion tests/test_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down