Package Health Score

52 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 2.58K
Forks: 1.19K
Contributors: 30

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Feb 2, 2021
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

LGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

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

Inactive

Commit Frequency

Open Issues: 14
Open PR: 3
Last Release: 4 years ago
Last Commit: 6 months ago

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

An important project maintenance signal to consider for ringbellerpythonapi is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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: 30
Funding: No

With more than 10 contributors for the ringbellerpythonapi 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 ringbellerpythonapi 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: 4 years
Latest Release: 4 years ago
Dependencies: N/A
Versions: 1
Maintainers: 1
Wheels: OS Independent

Readme

Ringbeller IoT Python API

1. Solution

The package builds a Python wrapper around the C++ Modem Library. The native C++ library is built with make to produce a shared library (.so) The shared library is loaded in Python with ctypes.

2. Sources

The original C++ Modem Library is copied in ringbellerpythonapi/src/modem. Main package file ringbellerpythonapi.py exports all functions supported by the C++ Modem Library.

3. Prerequisite: WiringPi

The WiringPi library is required by the C++ Modem Library for low-level hardware communication. To install the library:

Go to https://github.com/WiringPi/WiringPi
Download ZIP archive
Unzip archive: unzip WiringPi-final_official_2.50.zip
Compile and install library: cd WiringPi-final_official_2.50 ./build

4. Build C++ Modem Shared Library

> cd ringbellerpythonapi > cd src > make

5. Testing

Test scripts are placed in folder /tests The following script attempts to turn ON and OFF the modem (debugging logs enabled):

> cd tests > python3 testpower.py

where: = 1 for SIMULATED mode or = 0 for HARDWARE mode (e.g. 1)

6. API Functions

initialize(verbose, debug, serial_port, audio_device): Initialize modem. on(): Turn on the modem off(): Turn off the modem restart(): Restart the modem connect(): Connect to modem disconnect(): Disconnect from modem configure(): Configure modem send_sms(number, message): Send SMS message receive_sms(): Receive SMS message place_voice_call(number): Place call receive_voice_call(): Receive call get_call_status(): Get call status end_call(): Hang up active voice call begin_audio_playback(playback_file): Begin playing audio to voice call wait_for_audio_playback(): Wait for voice-call audio-playback to end end_audio_playback(): End playing audio to voice call begin_audio_recording(record_file): Begin recording audio from voice call end_audio_recording(): End recording audio from voice call send_mms(recipient, cc, bcc, title, attachment, protocol, apn, username, password, authentication, mmsc, proxy, port): Send MMS message get_keypad_input(length, audio_file): Get keypad input (IVR)

7. Logging

The logging options are provided when calling the "initialize" API function. The package supports following logging options:

verbose: log level from 0 to 4 0 - no logging 1 - errors displayed 2 - info and errors displayed 3 - info, errors and warnings displayed 4 - all messages displayed (info, errors, warnings and debug messages)
debug: specify 1 to enable debug simulation

FAQs

What is ringbellerpythonapi?

Ringbeller IoT - Cellular library Python bindings. Visit Snyk Advisor to see a full health score report for ringbellerpythonapi, including popularity, security, maintenance & community analysis.

Is ringbellerpythonapi popular?

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

Is ringbellerpythonapi well maintained?

We found indications that ringbellerpythonapi is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is ringbellerpythonapi safe to use?

The python package ringbellerpythonapi 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 27 November-2024, at 10:30 (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

ringbellerpythonapi

Ringbeller IoT - Cellular library Python bindings 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

Non-Permissive License

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Ringbeller IoT Python API

1. Solution

2. Sources

3. Prerequisite: WiringPi

4. Build C++ Modem Shared Library

5. Testing

6. API Functions

7. Logging

FAQs

What is ringbellerpythonapi?

Is ringbellerpythonapi popular?

Is ringbellerpythonapi well maintained?

Is ringbellerpythonapi 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

Ringbeller IoT Python API

1. Solution

2. Sources

3. Prerequisite: WiringPi

4. Build C++ Modem Shared Library

5. Testing

6. API Functions

7. Logging

FAQs

What is ringbellerpythonapi?

Is ringbellerpythonapi popular?

Is ringbellerpythonapi well maintained?

Is ringbellerpythonapi 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