pyblish-config


Namepyblish-config JSON
Version 0.0.2 PyPI version JSON
download
home_page
SummaryControl the flow and settings of your Pyblish plugins with config files
upload_time2023-08-02 08:05:38
maintainer
docs_urlNone
authorHannes D
requires_python>=3.4
license
keywords plugin addon add-on extension manager studio dcc pipeline
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyblish-config [![PyPI](https://img.shields.io/pypi/v/pyblish-config)](https://pypi.org/project/pyblish-config/) 

## overwriting attributes
to make sure your pipeline doesnt break when updating plugins.
pyblish config only overwrites settings it finds in the settings file
it leaves everything else at default value.

example:
a plugin has various attributes. the json only contains a single attribute, node_type = "mesh"
all attributes of the plugin will remain the same except for the node_type.

### create a config file
see [sample_create_config](sample/sample_create_config.py)

### apply a config file
see [sample_apply_config](sample/sample_apply_config.py)

## explicitly registering plugins
the exception to this is the plugins registered.
it will only use plugins matching the plugin names in the settings file

example:
you have 5 plugins registered. the settings file has 3 plugins listed.
only those 3 plugins will be used.

## config creator tool
See the [config creator](https://github.com/hannesdelbeke/pyblish-config/tree/main/pyblish_config_creator), a little qt helper tool to help you  create configs. (still in alpha, will have bugs)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pyblish-config",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.4",
    "maintainer_email": "",
    "keywords": "plugin,addon,add-on,extension,manager,studio,dcc,pipeline",
    "author": "Hannes D",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/26/5e/a57c0c3f670327025fb2e64ec1e7a0524bf395bf0c92a224f5d6a6234cac/pyblish-config-0.0.2.tar.gz",
    "platform": null,
    "description": "# pyblish-config [![PyPI](https://img.shields.io/pypi/v/pyblish-config)](https://pypi.org/project/pyblish-config/) \n\n## overwriting attributes\nto make sure your pipeline doesnt break when updating plugins.\npyblish config only overwrites settings it finds in the settings file\nit leaves everything else at default value.\n\nexample:\na plugin has various attributes. the json only contains a single attribute, node_type = \"mesh\"\nall attributes of the plugin will remain the same except for the node_type.\n\n### create a config file\nsee [sample_create_config](sample/sample_create_config.py)\n\n### apply a config file\nsee [sample_apply_config](sample/sample_apply_config.py)\n\n## explicitly registering plugins\nthe exception to this is the plugins registered.\nit will only use plugins matching the plugin names in the settings file\n\nexample:\nyou have 5 plugins registered. the settings file has 3 plugins listed.\nonly those 3 plugins will be used.\n\n## config creator tool\nSee the [config creator](https://github.com/hannesdelbeke/pyblish-config/tree/main/pyblish_config_creator), a little qt helper tool to help you  create configs. (still in alpha, will have bugs)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Control the flow and settings of your Pyblish plugins with config files",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/hannesdelbeke/pyblish-config",
        "Source": "https://github.com/hannesdelbeke/pyblish-config"
    },
    "split_keywords": [
        "plugin",
        "addon",
        "add-on",
        "extension",
        "manager",
        "studio",
        "dcc",
        "pipeline"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5356a0aa827d0a6a9a4ed5be130bebe589a533b80eb30e35bd610cd2945cbce5",
                "md5": "a92127fda5cc2f839adc8c7374726a32",
                "sha256": "fbfe8b38ac40758e508cad0eee5e2b21a09929e1f901e1eba59ee9fb4b159c15"
            },
            "downloads": -1,
            "filename": "pyblish_config-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a92127fda5cc2f839adc8c7374726a32",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 16840,
            "upload_time": "2023-08-02T08:05:37",
            "upload_time_iso_8601": "2023-08-02T08:05:37.410546Z",
            "url": "https://files.pythonhosted.org/packages/53/56/a0aa827d0a6a9a4ed5be130bebe589a533b80eb30e35bd610cd2945cbce5/pyblish_config-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "265ea57c0c3f670327025fb2e64ec1e7a0524bf395bf0c92a224f5d6a6234cac",
                "md5": "c1ec219f6ce0ccd27ac599daf8ab8dc1",
                "sha256": "63ada920af9e97a5be0d315693cffb249ffb8888c6b6ce64bd27d0ab9b8b4fce"
            },
            "downloads": -1,
            "filename": "pyblish-config-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "c1ec219f6ce0ccd27ac599daf8ab8dc1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 136287,
            "upload_time": "2023-08-02T08:05:38",
            "upload_time_iso_8601": "2023-08-02T08:05:38.399550Z",
            "url": "https://files.pythonhosted.org/packages/26/5e/a57c0c3f670327025fb2e64ec1e7a0524bf395bf0c92a224f5d6a6234cac/pyblish-config-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-02 08:05:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hannesdelbeke",
    "github_project": "pyblish-config",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pyblish-config"
}
        
Elapsed time: 0.12485s