funcnodes-module

Name	funcnodes-module JSON
Version	0.1.18 JSON
	download
home_page	None
Summary	None
upload_time	2024-10-21 13:52:24
maintainer	None
docs_url	None
author	Julian Kimmig
requires_python	>=3.11
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Funcnodes Module

This helper tool makes it easy to generate new modules for [Funcnodes](https://github.com/Linkdlab/funcnodes).

## Installation
```bash
pip install funcnodes-module
```

## Usage

### Create a New Module
To create a new module, simply run:
```bash
funcnodes-module new <name_of_your_package>
```
This will set up the required folder structure with template files and even prepare everything for publishing to GitHub (which is recommended).

### Update a Module
Funcnodes is still in early development, and new features are added regularly.  
To update your module, start a command line in the module folder and run:
```bash
funcnodes-module update
```

### Upgrade Templates
When new template options are added, `funcnodes-module` needs to be updated.  
This can be done via the standard pip upgrade path or through a self-updating method:
```bash
funcnodes-module upgrade
```

### Add Third-Party Notices
We wanted a simple way to automatically give credit to other packages we use. Keeping third-party notices up to date can be time-consuming, so we implemented:
```bash
funcnodes-module gen_third_party_notice
```
This command automatically generates the corresponding third-party notices.  
**IMPORTANT**: This is not legally valid as it may not cover every package and/or license. [IANAL](https://en.wikipedia.org/wiki/IANAL) applies here.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "funcnodes-module",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Julian Kimmig",
    "author_email": "julian.kimmig@gmx.net",
    "download_url": "https://files.pythonhosted.org/packages/8d/95/234511e074f3f359b9531fc72aacef8d95e9ed0ef0911388816872929422/funcnodes_module-0.1.18.tar.gz",
    "platform": null,
    "description": "# Funcnodes Module\n\nThis helper tool makes it easy to generate new modules for [Funcnodes](https://github.com/Linkdlab/funcnodes).\n\n## Installation\n```bash\npip install funcnodes-module\n```\n\n## Usage\n\n### Create a New Module\nTo create a new module, simply run:\n```bash\nfuncnodes-module new <name_of_your_package>\n```\nThis will set up the required folder structure with template files and even prepare everything for publishing to GitHub (which is recommended).\n\n### Update a Module\nFuncnodes is still in early development, and new features are added regularly.  \nTo update your module, start a command line in the module folder and run:\n```bash\nfuncnodes-module update\n```\n\n### Upgrade Templates\nWhen new template options are added, `funcnodes-module` needs to be updated.  \nThis can be done via the standard pip upgrade path or through a self-updating method:\n```bash\nfuncnodes-module upgrade\n```\n\n### Add Third-Party Notices\nWe wanted a simple way to automatically give credit to other packages we use. Keeping third-party notices up to date can be time-consuming, so we implemented:\n```bash\nfuncnodes-module gen_third_party_notice\n```\nThis command automatically generates the corresponding third-party notices.  \n**IMPORTANT**: This is not legally valid as it may not cover every package and/or license. [IANAL](https://en.wikipedia.org/wiki/IANAL) applies here.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": null,
    "version": "0.1.18",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3ece383941d66b62e48856b82d9bdf8cc549b85044437e44ed0fe3e76ccb2090",
                "md5": "e465c171672b80572cac4842d739cff4",
                "sha256": "15f6824c2775d6cacdc4f8825da7328d42dc5b524cbc232538f2ee030aa57a6d"
            },
            "downloads": -1,
            "filename": "funcnodes_module-0.1.18-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e465c171672b80572cac4842d739cff4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 25940,
            "upload_time": "2024-10-21T13:52:22",
            "upload_time_iso_8601": "2024-10-21T13:52:22.954169Z",
            "url": "https://files.pythonhosted.org/packages/3e/ce/383941d66b62e48856b82d9bdf8cc549b85044437e44ed0fe3e76ccb2090/funcnodes_module-0.1.18-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8d95234511e074f3f359b9531fc72aacef8d95e9ed0ef0911388816872929422",
                "md5": "9a716545aeb57a919213bfb8e9ba5b1a",
                "sha256": "b5eb5acfbd8908712410d0ca96412e0e39a22b92b3097327112847c3a1c1cd53"
            },
            "downloads": -1,
            "filename": "funcnodes_module-0.1.18.tar.gz",
            "has_sig": false,
            "md5_digest": "9a716545aeb57a919213bfb8e9ba5b1a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 18433,
            "upload_time": "2024-10-21T13:52:24",
            "upload_time_iso_8601": "2024-10-21T13:52:24.191877Z",
            "url": "https://files.pythonhosted.org/packages/8d/95/234511e074f3f359b9531fc72aacef8d95e9ed0ef0911388816872929422/funcnodes_module-0.1.18.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-21 13:52:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "funcnodes-module"
}