adafruit-circuitpython-macropad

v2.4.1

A helper library for the Adafruit MacroPad RP2040 For more information about how to use this package see README

Latest version published 1 month ago

License: MIT

PyPI

GitHub

Package Health Score

69 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Sustainable

Popularity

Limited

GitHub Stars: 90
Forks: 25
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package adafruit-circuitpython-macropad, we found that it has been starred 90 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 7, 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

MIT

Security Policy

We found a way for you to contribute to the project! Looks like adafruit-circuitpython-macropad 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

Sustainable

Commit Frequency

Open Issues: 3
Open PR: 0
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of adafruit-circuitpython-macropad based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that adafruit-circuitpython-macropad 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: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the adafruit-circuitpython-macropad repository, this is possibly a sign for a growing and inviting community.

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.*

Age: 2 years
Latest Release: 1 month ago
Dependencies: 7 Direct / 23 Total
Versions: 14
Maintainers: 1
Wheels: OS Independent

Readme

Introduction

A helper library for the Adafruit MacroPad RP2040.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

This library is designed to work withe the Adafruit MacroPad RP2040. Consider purchasing one from the Adafruit shop:

Adafruit MacroPad RP2040 Bare Bones Adafruit MacroPad RP2040 Starter Kit

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_macropad

Or the following command to update an existing version:

circup update

Usage Example

This example prints out the key pressed, the relative position of the rotary encoder and the state of the rotary encoder switch.

from adafruit_macropad import MacroPad
import time

macropad = MacroPad()

while True:
    key_event = macropad.keys.events.get()
    if key_event and key_event.pressed:
     print("Key pressed: {}".format(key_event.key_number))
    print("Encoder: {}".format(macropad.encoder))
    print("Encoder switch: {}".format(macropad.encoder_switch))
    time.sleep(0.4)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

adafruit-circuitpython-macropad dependencies

adafruit-blinka adafruit-circuitpython-debouncer adafruit-circuitpython-display-text adafruit-circuitpython-hid adafruit-circuitpython-midi adafruit-circuitpython-neopixel adafruit-circuitpython-simple-text-display

FAQs

What is adafruit-circuitpython-macropad?

A helper library for the Adafruit MacroPad RP2040. Visit Snyk Advisor to see a full health score report for adafruit-circuitpython-macropad, including popularity, security, maintenance & community analysis.

Is adafruit-circuitpython-macropad popular?

The python package adafruit-circuitpython-macropad receives a total of 285 weekly downloads. As such, adafruit-circuitpython-macropad popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is adafruit-circuitpython-macropad well maintained?

We found indications that adafruit-circuitpython-macropad maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is adafruit-circuitpython-macropad safe to use?

The python package adafruit-circuitpython-macropad was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 November-2024, at 16:00 (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