@pipcook/create-pipcook-plugin

Create plugin for Pipcook in only one command.

Usage no npm install needed!

<script type="module">
  import pipcookCreatePipcookPlugin from 'https://cdn.skypack.dev/@pipcook/create-pipcook-plugin';
</script>

README

@pipcook/create-pipcook-plugin

Create plugin for Pipcook in only one command via npm-init.

Getting started

The are many ways to create a plugin for Pipcook.

# via NPM
$ npm init @pipcook/pipcook-plugin --category data-collect my-plugin

# via Pipcook
$ pipcook plugin create my-plugin --category data-collect

To create a TypeScript(default) plugin:

$ npm init @pipcook/pipcook-plugin my-plugin

To create a plugin with its category:

$ npm init @pipcook/pipcook-plugin --category data-collect my-plugin

Supported categories of plugin are:

  • data-collect
  • data-access
  • data-process
  • model-define
  • model-train
  • model-evaluate

To create a Python plugin:

$ npm init @pipcook/create-pipcook-plugin --python

How to write a template for new plugin

  1. create a directory at ./templates, and name in v1-default-${plugin-category}.
  2. create an index.ts under created template directory, and write the template there.
  3. submit a Pull Request to this repository.

To debug the new plugin template, we could use npx command:

$ npm link
$ npx @pipcook/create-pipcook-plugin foobar --category new-category

License

MIT.