{"id":16220222,"url":"https://github.com/brianpugh/cookiecutter-esp-idf-component","last_synced_at":"2025-03-19T11:30:52.460Z","repository":{"id":104185064,"uuid":"231811962","full_name":"BrianPugh/cookiecutter-esp-idf-component","owner":"BrianPugh","description":"Cookiecutter template for an ESP-IDF component","archived":false,"fork":false,"pushed_at":"2020-01-05T18:39:33.000Z","size":13,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T18:23:06.034Z","etag":null,"topics":["c","cookiecutter","esp-idf","esp32","iot"],"latest_commit_sha":null,"homepage":"","language":"C","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/BrianPugh.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":"2020-01-04T18:46:17.000Z","updated_at":"2021-08-25T11:18:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"bcab45f0-7933-43db-b5fb-5f813e65855a","html_url":"https://github.com/BrianPugh/cookiecutter-esp-idf-component","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianPugh%2Fcookiecutter-esp-idf-component","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianPugh%2Fcookiecutter-esp-idf-component/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianPugh%2Fcookiecutter-esp-idf-component/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianPugh%2Fcookiecutter-esp-idf-component/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BrianPugh","download_url":"https://codeload.github.com/BrianPugh/cookiecutter-esp-idf-component/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243985823,"owners_count":20379212,"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":["c","cookiecutter","esp-idf","esp32","iot"],"created_at":"2024-10-10T11:58:10.637Z","updated_at":"2025-03-19T11:30:52.455Z","avatar_url":"https://github.com/BrianPugh.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Who is this for?\n\nIf you want to make a reusable component (library) for the ESP32, this repo\nwill generate the appropriate project structure, as well as fill out as much\nboilerplate as possible. This could save you an hour or two of error-prone \ntedious work when starting a project.\n\n# Usage\n\nFirst, make sure the python dependencies are installed:\n\n```\npip3 install -r requirements.txt\n```\n\nNext, we will use `cookiecutter` and Jolt's cookiecutter app template to \ngenerate a jolt application project.\n\n```\ncookiecutter -c v0.1.1 git@github.com:BrianPugh/cookiecutter-esp-idf-component.git\n```\n\nFollow the onscreen prompts; pressing \"enter\" will use the default value.\nThe prompts are described in more detail below:\n\n1. `full_name` - Your full name (for documentation).\n2. `component_name` - Name of the component.\n3. `component_var_name` - Name of app-related variables in code.\n\n# Features\n\nThis cookiecutter performs the following actions or sets up to allow you to perform\nthe following actions:\n\n## License\n\nThe MIT license will automatically be added to your repo. You may manually change\nthis.\n\n## Git\n\nGit will be initialized and all the files will be commited indicating \nthe verseion of this cookiecutter template you used.\n\nBuild artifacts will already be in the `.gitignore`\n\n## Unit Testing Build system\n\nThe Makefile will already be populated so that you can immediately build your\ncomponent with a unit-tester app. See the component's README for more information.\n\n## Versioning\n\nUse `bump2version` to manage your app's version. `bump2version` is a maintained\nfork of `bumpversion`.\n\n```\npip3 install bump2version\n```\n\nThis template already has a `.bumpversion.cfg` populated for you. In your project's\nclean (no unstaged changes) root directory, the following commands will increase\nthe version number and commit the version change:\n\n```\nbump2version major  # For backwards incompatible changes.\nbump2version minor  # For backwards compatible feature updates\nbump2version patch  # For bug fixes\n```\n\nI recommend adding the alias to your `~/.bashrc`\n\n```\nalias bumpversion=\"bump2version\"\n```\n\nComponent versioning information will be available in your component's header \nfile as:\n\n```\n{{cookiecutter.component_var_name | upper}}_VERSION_MAJOR\n{{cookiecutter.component_var_name | upper}}_VERSION_MINOR\n{{cookiecutter.component_var_name | upper}}_VERSION_PATCH\n```\n\nFor example,\n\n```\nMY_COMPONENT_VERSION_MAJOR\nMY_COMPONENT_VERSION_MINOR\nMY_COMPONENT_VERSION_PATCH\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianpugh%2Fcookiecutter-esp-idf-component","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrianpugh%2Fcookiecutter-esp-idf-component","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianpugh%2Fcookiecutter-esp-idf-component/lists"}