Package Health Score

72 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Popularity

Small

GitHub Stars: 2.46K
Forks: 900
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package libusbsio, we found that it has been starred 2,457 times.

Security

No known security issues

Security and license risk for latest version

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

BSD-3-Clause

Security Policy

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

No Recent Commits

Open Issues: 185
Open PR: 61
Last Release: 1 month ago
Last Commit: 8 years ago

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

We found that libusbsio 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: No
Contributors: 40
Funding: No

With more than 10 contributors for the libusbsio repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like libusbsio 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.6

Age: 3 years
Latest Release: 1 month ago
Dependencies: N/A
Versions: 12
Maintainers: 1
Wheels: OS Independent

Readme

Python wrapper for NXP libusbsio binary library

The NXP libusbsio is a binary library for Win/Linux/MacOS systems used to exercise SPI, I2C bus and GPIO pins over USBSIO interface of NXP LPCLink2 and MCUlink Pro devices.

This Python component provides a wrapper object which encapsulates the binary library and exposes its API to Python applications.

Author: michal.hanak@nxp.com (https://www.nxp.com)

Dependencies

There are no dependencies to any external modules needed to use the LIBUSBSIO module.

The binary libraries use the HID_API library code and partially also its new libusb/hidapi version to access the USB HID interface on all supported OS platforms.

Installation

pypi.org

Use pip to download and install the package

python -m pip install libusbsio

Local

Use the following pip command to install the libusbsio module from the local NXP LIBUSBSIO installation package available at www.nxp.com:

python -m pip install dist/libusbsio-2.1.13-py3-none-any.whl

Running example code

Running the example code is easy. You do not even need to install the package, the example code will locate the module in the local directory (in ../libusbsio).

Go to examples directory and see the demo scripts there. Examine the script and the way how it creates the LIBUSBSIO object.

Without any constructor parameters, the USBSIO library is automatically located. There are also options to load the library from a given path.

from libusbsio import *
sio = LIBUSBSIO()

Use the loglevel parameter to specify logging verbosity:

import logging
from libusbsio import *

logging.basicConfig()
sio = LIBUSBSIO(loglevel=logging.INFO)

Running test code

The test code is located in the test directory and it is ready to be used with the unittest or pytest. Note that most of the tests assume that the target MCU application runs the siotest1 application test code which answers on SPI and I2C buses using a simple command/response protocol. The source code of the siotest application for different target boards is available as an optional part of the NXP MCUXpresso SDK package.

Run one of the following commands in the base 'python' directory. Note that some long duration tests and known-issues tests are skipped by default. See more in test/test_base.py main test file.

python -m unittest
.............s.......s...s...sssss.........s.
----------------------------------------------------------------------
Ran 45 tests in 11.034s

OK (skipped=9)

or:

pyttest

===================================== test session starts ======================================
platform win32 -- Python 3.8.7, pytest-6.2.3, py-1.10.0, pluggy-0.13.1
rootdir: d:\gitwork\libusbsio\python
collected 45 items

test\test_00_lib.py ..........                                                            [ 22%]
test\test_10_spi.py ...s....                                                              [ 40%]
test\test_20_i2c.py ...s...s...s...ssss                                                   [ 82%]
test\test_30_gpio.py ......s.                                                             [100%]

================================ 36 passed, 9 skipped in 11.38s ================================

History

v2.1.13 - October 2024

Fix HID_API Windows enumeration to avoid accidental duplicate device enumeration.

v2.1.12 - January 2023

Fix HID_API Windows to enable both debugger interface and USBSIO device to be open simultaneously.

v2.1.11 - February 2022

Source code of the library made available under BSD-3-Clause license.
macOS now use the libusb/hidapi version to use a new format of HID device path.

v2.1.10 - February 2022

Add GetDeviceInfo method to retrieve hid_api low-level information of the SIO port

v2.1.8 - November 2021

Add binaries for linux_armv7l and linux_aarch64

v2.1.5 - August 2021

Add binaries and support for arm64 macOS

v2.1.4 - July 2021

Extend by low-level HID_API access, fix read buffer length when reading data.
Refactor "PIDVID" variables, arguments and tuples to a correctly ordered "VIDPID"
Fix example code.

v2.1.0 - April 2021

The initial Python libusbsio library wrapper release supporting USBSIO library v2.1

FAQs

What is libusbsio?

Python wrapper around NXP LIBUSBSIO library. Visit Snyk Advisor to see a full health score report for libusbsio, including popularity, security, maintenance & community analysis.

Is libusbsio popular?

The python package libusbsio receives a total of 937 weekly downloads. As such, libusbsio popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is libusbsio well maintained?

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

Is libusbsio safe to use?

The python package libusbsio 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 22 November-2024, at 15:13 (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