Metadata-Version: 2.1
Name: plugin-package-template
Version: 0.1.477708478
Summary: Plugin template project used to quick start development of a new Versatile Data Kit SDK plugin.
Home-page: https://github.com/vmware/versatile-data-kit
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown

# 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

<!--
Explain how your plugin is used, what configuration is exposed and provide examples
-->

## 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


