Package Health Score

73 / 100

security
Security review needed
popularity
Recognized
maintenance
Healthy
community
Sustainable

Popularity

Recognized

GitHub Stars: 14
Forks: 6
Contributors: 9

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package idf-build-apps, we found that it has been starred 14 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 4, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like idf-build-apps is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 6
Open PR: 1
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of idf-build-apps based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that idf-build-apps demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 9
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like idf-build-apps is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7

Age: 2 years
Latest Release: 2 months ago
Dependencies: 4 Direct / 13 Total
Versions: 63
Maintainers: 2
Wheels: OS Independent

Readme

idf-build-apps

idf-build-apps is a tool that helps users find and build ESP-IDF, and ESP8266 RTOS projects in a large scale.

What is an `app`?

A project using ESP-IDF SDK, or ESP8266 RTOS SDK typically contains:

Build recipe in CMake or Make and the main component with app sources
(Optional) One or more sdkconfig files

app is the abbreviation for application. An application is a set of binary files that is being built with the specified sdkconfig and the target chip. idf-build-apps could build one project into a number of applications according to the matrix of these two parameters.

Installation

pip install idf-build-apps

or pipx

pipx install idf-build-apps

Basic Usage

idf-build-apps is a python package that could be used as a library or a CLI tool.

As a CLI tool, it contains three sub-commands.

find to find the buildable applications
build to build the found applications
completions to activate autocompletions or print instructions for manual activation

For detailed explanation to all CLI options, you may run

idf-build-apps -h
idf-build-apps find -h
idf-build-apps build -h
idf-build-apps completions -h

As a library, you may check the API documentation for more information. Overall it provides

Two functions, find_apps and build_apps
Two classes, CMakeApp and MakeApp

Quick CLI Example

To build ESP-IDF hello world example project with ESP32:

idf-build-apps build -p $IDF_PATH/examples/get-started/hello_world/ --target esp32

The binary files will be generated under $IDF_PATH/examples/get-started/hello_world/build directory.

Documentation

For detailed information, please refer to our documentation site!

Contributing

Thanks for your contribution! Please refer to our Contributing Guide

idf-build-apps dependencies

packaging pydantic-settings pyparsing pyyaml

FAQs

What is idf-build-apps?

Tools for building ESP-IDF related apps. Visit Snyk Advisor to see a full health score report for idf-build-apps, including popularity, security, maintenance & community analysis.

Is idf-build-apps popular?

The python package idf-build-apps receives a total of 45,213 weekly downloads. As such, idf-build-apps popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is idf-build-apps well maintained?

We found that idf-build-apps demonstrated a healthy version release cadence and project activity. It has a community of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is idf-build-apps safe to use?

While scanning the latest version of idf-build-apps, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 22 November-2024, at 12:05 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

idf-build-apps

Tools for building ESP-IDF related apps. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

idf-build-apps

What is an `app`?

Installation

Basic Usage

Quick CLI Example

Documentation

Contributing

idf-build-apps dependencies

FAQs

What is idf-build-apps?

Is idf-build-apps popular?

Is idf-build-apps well maintained?

Is idf-build-apps safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

idf-build-apps

What is an app?

Installation

Basic Usage

Quick CLI Example

Documentation

Contributing

idf-build-apps dependencies

FAQs

What is idf-build-apps?

Is idf-build-apps popular?

Is idf-build-apps well maintained?

Is idf-build-apps safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

What is an `app`?