https://github.com/brianpugh/cookiecutter-esp-idf-component
Cookiecutter template for an ESP-IDF component
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.4%) to scientific vocabulary
Keywords
Repository
Cookiecutter template for an ESP-IDF component
Statistics
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
- Releases: 2
Topics
Metadata Files
README.md
Who is this for?
If you want to make a reusable component (library) for the ESP32, this repo will generate the appropriate project structure, as well as fill out as much boilerplate as possible. This could save you an hour or two of error-prone tedious work when starting a project.
Usage
First, make sure the python dependencies are installed:
pip3 install -r requirements.txt
Next, we will use cookiecutter and Jolt's cookiecutter app template to
generate a jolt application project.
cookiecutter -c v0.1.1 git@github.com:BrianPugh/cookiecutter-esp-idf-component.git
Follow the onscreen prompts; pressing "enter" will use the default value. The prompts are described in more detail below:
full_name- Your full name (for documentation).component_name- Name of the component.component_var_name- Name of app-related variables in code.
Features
This cookiecutter performs the following actions or sets up to allow you to perform the following actions:
License
The MIT license will automatically be added to your repo. You may manually change this.
Git
Git will be initialized and all the files will be commited indicating the verseion of this cookiecutter template you used.
Build artifacts will already be in the .gitignore
Unit Testing Build system
The Makefile will already be populated so that you can immediately build your component with a unit-tester app. See the component's README for more information.
Versioning
Use bump2version to manage your app's version. bump2version is a maintained
fork of bumpversion.
pip3 install bump2version
This template already has a .bumpversion.cfg populated for you. In your project's
clean (no unstaged changes) root directory, the following commands will increase
the version number and commit the version change:
bump2version major # For backwards incompatible changes.
bump2version minor # For backwards compatible feature updates
bump2version patch # For bug fixes
I recommend adding the alias to your ~/.bashrc
alias bumpversion="bump2version"
Component versioning information will be available in your component's header file as:
{{cookiecutter.component_var_name | upper}}_VERSION_MAJOR
{{cookiecutter.component_var_name | upper}}_VERSION_MINOR
{{cookiecutter.component_var_name | upper}}_VERSION_PATCH
For example,
MY_COMPONENT_VERSION_MAJOR
MY_COMPONENT_VERSION_MINOR
MY_COMPONENT_VERSION_PATCH
Owner
- Name: Brian Pugh
- Login: BrianPugh
- Kind: user
- Location: Washington D.C.
- Repositories: 123
- Profile: https://github.com/BrianPugh
Deep Learning Scientist and blockchain enthusiast
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: over 1 year ago
All Time
- Total issues: 1
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- BrianPugh (1)