FuncNodes Module
A tool for creating and managing modules for the Funcnodes framework.
📌 Features
- 🚀 Quick module setup with predefined templates.
- 🔌 Optional React plugin for frontend integration.
- 🛠 Automatic Git initialization (optional).
- ✅ Pre-configured testing using pytest.
- 📂 Python packaging support with pyproject.toml.
📦 Installation
python -m pip install funcnodes-module
Ensure you have Python 3.11+ installed.
🎯 Usage
General Syntax
funcnodes-module <command> [options]
1️⃣ Creating a New Module
funcnodes-module new <name> [options]
| Argument | Description |
|---|---|
| name | The name of the new module. |
| --with_react | Adds React plugin templates. |
| --nogit | Skips Git initialization. |
| --path | Specifies a custom directory for the module. |
Example:
funcnodes-module new my_module --with_react --nogit --path ~/projects
2️⃣ Updating an Existing Module
funcnodes-module update [options]
| Argument | Description |
|---|---|
| --nogit | Skips Git initialization. |
| --path | Specifies the project directory. |
| --force | Forces overwriting of certain files. |
| --project_name | Manually specify the project name. |
| --module_name | Manually specify the module name. |
| --package_name | Manually specify the package name. |
3️⃣ Generating a Third-Party Notice File
funcnodes-module gen_third_party_notice [options]
| Argument | Description |
|---|---|
| --path | Specifies the project directory. |
IMPORTANT: This is not legally valid as it may not cover every package and/or license. IANAL applies here.
4️⃣ Running a Demo Worker
funcnodes-module demoworker
This command:
Creates a demo worker if it doesn’t exist. Starts the worker and a FuncNodes server. 📁 Folder Structure
my_module/
│── src/
│ ├── my_module/ # Python package
│ │ ├── **init**.py
│ │ ├── main.py
│ ├── tests/
│ │ ├── test_my_module.py
│ ├── react_plugin/ # Optional React Plugin
│ ├── pyproject.toml # Python packaging
│ ├── README.md
│ ├── LICENSE
│ ├── .gitignore
🛠 Development & Testing Run Tests
pytest
Build & Install Locally
pip install .
📜 License
This project is licensed under the MIT License.
Release files for funcnodes-module 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| funcnodes_module-0.4.1.tar.gz | 164.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| funcnodes_module-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 203.0 kB
Release files / funcnodes_module-0.4.1.tar.gz
| Download URL | funcnodes_module-0.4.1.tar.gz |
|---|---|
| Size | 164.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e05bff76e87481abfaf95a3a45fe73f99a4a2cfb93fdc4cb957ace33886f91fd
|
|
BLAKE2b-256 checksum How to use checksums |
52cb60dd3c5ff4f95d1cfbfebe25391da3be3da65777486610a664e81a147557
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 7, 2025.
Transparency logRelease files / funcnodes_module-0.4.1-py3-none-any.whl
| Download URL | funcnodes_module-0.4.1-py3-none-any.whl |
|---|---|
| Size | 39.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
79edbb75ebd9392243b3b74ac38719c47829fcd9bff40767df00431cf1846fd0
|
|
BLAKE2b-256 checksum How to use checksums |
bf330dbc0f8c15f5549340fd8c58582f3484de0b3f3f9de12640083073c20bd0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 7, 2025.
Transparency log