plugin-package-template

v0.1.477708478

Plugin template project used to quick start development of a new Versatile Data Kit SDK plugin. For more information about how to use this package see README

Latest version published 3 years ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

51 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Popularity

Limited

GitHub Stars: 433
Forks: 57
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package plugin-package-template, we found that it has been starred 433 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Feb 23, 2022
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 plugin-package-template 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: 225
Open PR: 15
Last Release: 3 years ago
Last Commit: 18 days ago

Further analysis of the maintenance status of plugin-package-template 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 plugin-package-template 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.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

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

With more than 10 contributors for the plugin-package-template 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.10.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 3 years
Latest Release: 3 years ago
Dependencies: N/A
Versions: 10
Maintainers: 1
Wheels: No

Readme

The name of the plugin

Instructions:

(delete this section after reading and completing the instructions)

This directory outlines a template which specifies the implementation of all vdk plugins. It includes a setup.py file, a /src/ directory containing all the plugin hooks and additional implementation files, a /tests/ directory containing all plugin-specific tests, and a .plugin-ci.yml file which specifies the CI/CD relevant to the plugins.

The CI/CD is separated in two stages, a build stage and a release stage. The build stage is made up of a few jobs, all which inherit from the same job configuration and only differ in the Python version they use (3.7, 3.8, 3.9 and 3.10). They run according to rules, which are ordered in a way such that changes to a plugin's directory trigger the plugin CI, but changes to a different plugin does not.

In order to add a new plugin, copy the plugin-template directory and follow the instructions in the files. Generally those are

Update the setup.py file with correct name of the plugin;
Update .plugin-ci.yml file with name of the plugin - make sure to follow comments;
Include your implementation files inside the src folder;
Include any tests inside the tests so they can be ran by CI framework automatically.

Usage

Build and testing

In order to build and test a plugin go to the plugin directory and use ../build-plugin.sh script to build it

FAQs

What is plugin-package-template?

Plugin template project used to quick start development of a new Versatile Data Kit SDK plugin. Visit Snyk Advisor to see a full health score report for plugin-package-template, including popularity, security, maintenance & community analysis.

Is plugin-package-template popular?

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

Is plugin-package-template well maintained?

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

Is plugin-package-template safe to use?

While scanning the latest version of plugin-package-template, 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 26 November-2024, at 19:48 (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