{"id":19745198,"url":"https://github.com/freecad/freecad.workbench_starterkit","last_synced_at":"2026-03-11T01:31:41.950Z","repository":{"id":57432191,"uuid":"86782329","full_name":"FreeCAD/freecad.workbench_starterkit","owner":"FreeCAD","description":"Template for workbench addons.","archived":false,"fork":false,"pushed_at":"2025-11-13T17:46:14.000Z","size":77,"stargazers_count":52,"open_issues_count":4,"forks_count":25,"subscribers_count":29,"default_branch":"master","last_synced_at":"2025-11-28T03:18:01.384Z","etag":null,"topics":["addon","cookie-cutter","freecad","template","workbench"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FreeCAD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"zenodo":null}},"created_at":"2017-03-31T05:44:41.000Z","updated_at":"2025-11-22T15:22:03.000Z","dependencies_parsed_at":"2024-12-08T03:25:50.934Z","dependency_job_id":"949c0040-824a-43d9-92c2-0e4057b0a88e","html_url":"https://github.com/FreeCAD/freecad.workbench_starterkit","commit_stats":{"total_commits":52,"total_committers":9,"mean_commits":5.777777777777778,"dds":0.7115384615384616,"last_synced_commit":"30f590c765c8f8fdf316f6d2b6c46e855720502d"},"previous_names":["looooo/templateextension","freecad/workbench-starterkit"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/FreeCAD/freecad.workbench_starterkit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2Ffreecad.workbench_starterkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2Ffreecad.workbench_starterkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2Ffreecad.workbench_starterkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2Ffreecad.workbench_starterkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FreeCAD","download_url":"https://codeload.github.com/FreeCAD/freecad.workbench_starterkit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2Ffreecad.workbench_starterkit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27728261,"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-12-14T02:00:11.348Z","response_time":56,"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","cookie-cutter","freecad","template","workbench"],"created_at":"2024-11-12T02:04:59.665Z","updated_at":"2025-12-14T12:22:38.451Z","avatar_url":"https://github.com/FreeCAD.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FreeCAD Workbench Starter Kit\n\nCookieCutter template for generating FreeCAD workbenches. NOTE: You do not need to fork this template to use it, just follow the \"Quick Start\" instructions below.\n\n## Dependencies\n\n* python3\n* [cookiecutter](https://cookiecutter.readthedocs.io)\n\n## Quick Start\n\n### Create a workbench\n\nLaunch cookiecutter and point it at the template repo:\n\n```bash\n$ cookiecutter https://github.com/FreeCAD/freecad.workbench_starterkit.git\n```\n\nAnswer the questions:\n\n```bash\n  [1/13] workbench_project_name (cool_wb): \n  [2/13] workbench_module_name (cool_wb): \n  [3/13] workbench_class_name (CoolWorkbench): \n  [4/13] workbench_menu_text (cool workbench): \n  [5/13] workbench_tooltip (FreeCAD workbench to make cool parametric objects): \n  [6/13] workbench_icon (cool.svg): \n  [8/13] workbench_maintainer_name (me): \n  [9/13] workbench_maintainer_email (me@foobar.com): \n  [10/13] workbench_project_url (https://foobar.com/me/coolWB): \n  [11/13] workbench_description (The cool WB creates cool parametric objects): \n  [12/13] workbench_dependencies ('numpy',): \n  [13/13] workbench_version (0.1.0): \n```\n\nVoila, the workbench has been created in a directory under the current directory:\n\n```bash\n$ find cool_wb/\n```\n\nShows...\n\n```bash\ncool_wb/\ncool_wb/setup.py\ncool_wb/docs\ncool_wb/docs/HISTORICAL_README.md\ncool_wb/docs/commands.md\ncool_wb/MANIFEST.in\ncool_wb/freecad\ncool_wb/freecad/cool_wb\ncool_wb/freecad/cool_wb/init_gui.py\ncool_wb/freecad/cool_wb/version.py\ncool_wb/freecad/cool_wb/__init__.py\ncool_wb/freecad/cool_wb/my_numpy_function.py\ncool_wb/freecad/cool_wb/resources\ncool_wb/freecad/cool_wb/resources/cool.svg\ncool_wb/freecad/cool_wb/resources/translations\ncool_wb/freecad/cool_wb/resources/translations/{{cookiecutter.workbench_module_name}}_es-ES.ts\ncool_wb/freecad/cool_wb/resources/translations/update_translation.sh\ncool_wb/freecad/cool_wb/resources/translations/{{cookiecutter.workbench_module_name}}_es-ES.qm\ncool_wb/README.md\ncool_wb/LICENSE\n```\n\n### Install the workbench\n\nThe easiest way (I've found) to install a newly created workbench is to just symlink it into the `Mod` directory.\n\n```bash\n# cd to the Mod directory of your FreeCAD installation]\ncd [FreeCAD installation directory]/Mod\nln -s [path to the created workbench] CoolWB\ncd ..\n./bin/FreeCAD\n```\n\nLook for the workbench in the FreeCAD -\u003e View -\u003e Workbenches, it should be there.\n\n## Documentation\n\nFor much deeper documentation, see the generated docs/HISTORICAL_README.md.\n\n## For Installation into FreeCAD source\n\n1. Add option to build this app here\n\ncMake/FreeCAD_Helpers/InitializeFreeCADBuildOptions.cmake\n```cmake\noption(BUILD_COOLWB \"Build the FreeCAD CoolWB module\" ON)\n```\n\n2. Condition on that option here\n\nsrc/Mod/CMakeLists.txt\n```cmake\n+if(BUILD_COOLWB)\n+    add_subdirectory(CoolWB)\n+endif(BUILD_COOL_WB)\n```\n\n## For Installation into the AddOnManager\n\nSee instructions here:\nhttps://github.com/FreeCAD/FreeCAD-addons/blob/master/README.md\n\n\n## Maintainer\n\nToddG : freecad.ascension109@passinbox.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreecad%2Ffreecad.workbench_starterkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreecad%2Ffreecad.workbench_starterkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreecad%2Ffreecad.workbench_starterkit/lists"}