funcnodes-module

Name	funcnodes-module JSON
Version	0.1.19 JSON
	download
home_page	None
Summary	None
upload_time	2024-11-05 08:39:17
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/d1/8d/988fc03a0148370d1fd1d697169527e95f0969714bf5dba9482eb06e00b5/funcnodes_module-0.1.19.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.19",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1568d6ddb0cdceb087bbaabddfc8bebf46c28e850bed590e90fbd5ee0632d04",
                "md5": "920b229b8e30f37fdc66bd986d7e44b7",
                "sha256": "121de763750f9b251e04694076f629c15ec7d05029385e6b3684acd5bd6753a1"
            },
            "downloads": -1,
            "filename": "funcnodes_module-0.1.19-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "920b229b8e30f37fdc66bd986d7e44b7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 25941,
            "upload_time": "2024-11-05T08:39:16",
            "upload_time_iso_8601": "2024-11-05T08:39:16.586305Z",
            "url": "https://files.pythonhosted.org/packages/a1/56/8d6ddb0cdceb087bbaabddfc8bebf46c28e850bed590e90fbd5ee0632d04/funcnodes_module-0.1.19-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d18d988fc03a0148370d1fd1d697169527e95f0969714bf5dba9482eb06e00b5",
                "md5": "b320cd0391516dab24473dd8245d7c27",
                "sha256": "a260ae5f10d4944170efd673879e66e9646d33f3e4820513e662f585a05983a7"
            },
            "downloads": -1,
            "filename": "funcnodes_module-0.1.19.tar.gz",
            "has_sig": false,
            "md5_digest": "b320cd0391516dab24473dd8245d7c27",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 18450,
            "upload_time": "2024-11-05T08:39:17",
            "upload_time_iso_8601": "2024-11-05T08:39:17.990067Z",
            "url": "https://files.pythonhosted.org/packages/d1/8d/988fc03a0148370d1fd1d697169527e95f0969714bf5dba9482eb06e00b5/funcnodes_module-0.1.19.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-05 08:39:17",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "funcnodes-module"
}