{"id":18756521,"url":"https://github.com/octoprint/cookiecutter-octoprint-plugin","last_synced_at":"2025-04-13T02:01:58.243Z","repository":{"id":31937130,"uuid":"35506722","full_name":"OctoPrint/cookiecutter-octoprint-plugin","owner":"OctoPrint","description":"Cookiecutter template for creating OctoPrint plugins.","archived":false,"fork":false,"pushed_at":"2024-07-04T11:50:20.000Z","size":70,"stargazers_count":12,"open_issues_count":0,"forks_count":11,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-26T19:44:27.146Z","etag":null,"topics":["cookiecutter","cookiecutter-template","octoprint","octoprint-plugin-template","plugin","template"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OctoPrint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2015-05-12T18:54:04.000Z","updated_at":"2024-09-17T14:41:52.000Z","dependencies_parsed_at":"2024-11-07T17:52:59.622Z","dependency_job_id":null,"html_url":"https://github.com/OctoPrint/cookiecutter-octoprint-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2Fcookiecutter-octoprint-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2Fcookiecutter-octoprint-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2Fcookiecutter-octoprint-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2Fcookiecutter-octoprint-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctoPrint","download_url":"https://codeload.github.com/OctoPrint/cookiecutter-octoprint-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654045,"owners_count":21140235,"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","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":["cookiecutter","cookiecutter-template","octoprint","octoprint-plugin-template","plugin","template"],"created_at":"2024-11-07T17:36:58.693Z","updated_at":"2025-04-13T02:01:58.198Z","avatar_url":"https://github.com/OctoPrint.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cookiecutter Template for OctoPrint Plugins\n\nThis is a template for use with [Cookiecutter](https://github.com/audreyr/cookiecutter) to quickly create an \n[OctoPrint](https://github.com/foosel/OctoPrint) plugin project folder out of thin air :)\n\n![OctoPrint meets Cookiecutter](https://raw.githubusercontent.com/OctoPrint/cookiecutter-octoprint-plugin/master/assets/octoprint-cookiecutter.png)\n\n## How to use\n\n[Cookiecutter](https://github.com/audreyr/cookiecutter) depends on Python (just like OctoPrint). So first make sure\nthat is installed.\n\nThen install Cookiecutter:\n\n    pip install cookiecutter\n\nYou can then use Cookiecutter to create your new plugin's project folder (this example assumes we'll create it under \n`~/devel/`):\n\n    cookiecutter gh:OctoPrint/cookiecutter-octoprint-plugin\n\nCookiecutter will take care of cloning this repository and ask you a couple of questions to properly turn the template\ninto your very own plugin project folder:\n\n    Cloning into 'cookiecutter-octoprint-plugin'...\n    remote: Counting objects: 25, done.\n    remote: Compressing objects: 100% (15/15), done.\n    remote: Total 25 (delta 0), reused 25 (delta 0), pack-reused 0\n    Unpacking objects: 100% (25/25), done.\n    Checking connectivity... done.\n    plugin_identifier (default is \"skeleton\")?\n    plugin_name (default is \"OctoPrint-Skeleton\")?\n    repo_name (default is \"OctoPrint-Skeleton\")?\n    full_name (default is \"You\")?\n    email (default is \"you@example.com\")?\n    github_username (default is \"you\")?\n    plugin_version (default is \"0.1.0\")?\n    plugin_description (default is \"TODO\")?\n    plugin_license (default is \"AGPLv3\")?\n    plugin_homepage (default is \"https://github.com/you/OctoPrint-Skeleton\")?\n    plugin_source (default is \"https://github.com/you/OctoPrint-Skeleton\")?\n    plugin_installurl (default is \"https://github.com/you/OctoPrint-Skeleton/archive/master.zip\")?\n\n----\n\n**Note**: You can create a file `~/.cookiecutterrc` that cookiecutter will use to prefill things like `full_name`,\n`email` and `github_username`:\n\n``` yaml\ndefault_context:\n    full_name: \"Your full name\"\n    email: \"Your email address\"\n    github_username: \"Your Github username\"\n```\n\nThat way you won't have to re-enter that information every time you create a new plugin.\n\n----\n\nThe template will also generate a pre filled (well, as far as possible...) data file under `\u003crepo_name\u003e/extras/\u003cplugin_identifier\u003e.md`\nyou can complete after your plugin is ready for prime time (adding a proper description, a bunch of screenshots and\na release date) to [publish your plugin on plugins.octoprint.org](http://plugins.octoprint.org/help/registering/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctoprint%2Fcookiecutter-octoprint-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctoprint%2Fcookiecutter-octoprint-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctoprint%2Fcookiecutter-octoprint-plugin/lists"}