{"id":30727959,"url":"https://github.com/bblanimation/background-processing","last_synced_at":"2025-09-03T14:52:54.075Z","repository":{"id":237408903,"uuid":"164473099","full_name":"bblanimation/background-processing","owner":"bblanimation","description":"Send taxing Blender operations to the background with subprocess","archived":false,"fork":false,"pushed_at":"2020-06-03T04:12:36.000Z","size":151,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-01T12:15:41.260Z","etag":null,"topics":["addon","blender","blender-addon","blender-plugin","blender-processes","blender-python","blender-scripts","blender3d","bpy","bpython","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bblanimation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"bblanimation","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-01-07T18:21:33.000Z","updated_at":"2024-05-01T12:15:45.904Z","dependencies_parsed_at":"2024-05-01T12:15:45.287Z","dependency_job_id":"704d68f6-8c9b-492c-a43c-2f9e17dc115b","html_url":"https://github.com/bblanimation/background-processing","commit_stats":null,"previous_names":["bblanimation/background-processing"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bblanimation/background-processing","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bblanimation%2Fbackground-processing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bblanimation%2Fbackground-processing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bblanimation%2Fbackground-processing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bblanimation%2Fbackground-processing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bblanimation","download_url":"https://codeload.github.com/bblanimation/background-processing/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bblanimation%2Fbackground-processing/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273460595,"owners_count":25109761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addon","blender","blender-addon","blender-plugin","blender-processes","blender-python","blender-scripts","blender3d","bpy","bpython","python3"],"created_at":"2025-09-03T14:52:51.169Z","updated_at":"2025-09-03T14:52:54.068Z","avatar_url":"https://github.com/bblanimation.png","language":"Python","funding_links":["https://github.com/sponsors/bblanimation"],"categories":[],"sub_categories":[],"readme":"# 'Background Processing':\n\nRun blender processes in the background with separate instances of Blender.\n\n[Demo of the Background Processor on YouTube](https://youtu.be/8iIMP1SrHIE)\n\n# Instructions for Use:\n\n* First, add the background processor as a submodule to your addon module\n* Write your own background processing scripts\n    * Background processing scripts will be executed from within a separate Blender instance\n        * This allows for Blender-only module imports such as bpy and bmesh\n        * This also allows for access to the source file's blend data (if no existing blend data must be accessed, consider setting `use_blend_file` to False in `JobManager.add_job` API call for efficiency)\n    * Background processing scripts can report their progress with `update_job_progress` function\n        * `update_job_progress` takes one float argument from 0.0 to 1.0\n        * use `update_job_progress` calls judiciously, as the function has a file write cost\n    * Background processing scripts can access the source file's blend data in two ways\n        * Set `use_blend_file` to `True` in `JobManager.add_job` API call (may prove costly for large blend files)\n        * Pass blend data directly to the script via the `passed_data_blocks` parameter of the `JobManager.add_job` API call\n            * Any blend data passed this way will be available as local blend data in the background processing script\n            * All blend data passed this way will also be available to the background processing script a `passed_data_blocks` variable\n    * Background processing scripts should include a `python_data` variable\n        * `python_data` variable should be set to dictionary containing any necessary data to retrieve\n        * these data blocks can then be accessed with the `JobManager.get_retrieved_python_data` API call upon job completion.\n    * Background processing scripts should include a `data_blocks` variable\n        * `data_blocks` variable should be set to list of Blend data blocks\n        * The background processor will automatically copy these data blocks to the active instance of Blender upon job completion\n        * these data blocks can then be accessed with the `JobManager.get_retrieved_data_blocks` API call upon job completion.\n            * Example use: `JobManager.get_retrieved_data_blocks(job).objects`\n            * NOTE:\n                ``` Python\n                dir(JobManager.get_retrieved_data_blocks(job)) = [\n                    'actions',\n                    'armatures',\n                    'brushes',\n                    'cache_files',\n                    'cameras',\n                    'curves',\n                    'fonts',\n                    'grease_pencil',\n                    'groups',\n                    'images',\n                    'ipos',\n                    'lamps',\n                    'lattices',\n                    'linestyles',\n                    'masks',\n                    'materials',\n                    'meshes',\n                    'metaballs',\n                    'movieclips',\n                    'node_groups',\n                    'objects',\n                    'paint_curves',\n                    'palettes',\n                    'particles',\n                    'scenes',\n                    'sounds',\n                    'speakers',\n                    'texts',\n                    'textures',\n                    'worlds',\n                ]\n                ```\n* Send scripts to the JobManager for execution\n    * Jobs can be added from within a separate operator/code block using the following code:\n        ``` Python\n        from .job_manager import *  # relative JobManager import path (current path assumes script is in same root folder as 'JobManager.py')\n        job = \"/tmp/test_script.py\"  # REPLACE with path to your background processing script\n        job_manager = JobManager.get_instance()\n        job_manager.add_job(job)\n        ```\n    * You'll find the entire background processing API in the Job Manager class (`classes/job_manager.py`)\n    * See `classes/add_job.py` for an example use of the JobManager class API in a custom operator\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbblanimation%2Fbackground-processing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbblanimation%2Fbackground-processing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbblanimation%2Fbackground-processing/lists"}