https://github.com/pwwang/pipen-cli-init

A pipen CLI plugin to create a pipen project (pipeline)
https://github.com/pwwang/pipen-cli-init

cli pipeline

Last synced: 14 days ago
JSON representation

A pipen CLI plugin to create a pipen project (pipeline)

• Host: GitHub
• URL: https://github.com/pwwang/pipen-cli-init
• Owner: pwwang
• Created: 2021-09-18T23:52:59.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T23:56:27.000Z (5 months ago)
• Last Synced: 2024-12-13T03:51:33.607Z (21 days ago)
• Topics: cli, pipeline
• Language: Python
• Homepage:
• Size: 359 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# pipen-cli-init

A [`pipen`][1] cli plugin to create a pipen project (pipeline)

## Installation

```shell

pip install -U pipen-cli-init

```

## Enablig/Disabling the plugin

Installing this plugin will enable it, and uninstalling will disable it.

## Usage

```shell

❯ pipen init --help

Usage: pipen init [-h] [dir]

Initialize a pipen project (pipeline)

Optional Arguments:

  -h, --help  show help message and exit

Positional Arguments:

  dir         The directory to create the project in [default: ./]

```

## Example

```shell

> cd example-pipeline/

> pipen init

> # answer the questions

> # after the project is created, install the dependencies

> poetry install

> # run the pipeline

> poetry run python -m 

> # or if you choose console_script to be True

> poetry run 

```

If you want to publish the pipeline:

```shell

poetry publish --build

```

Then you can install it and run the pipeline globally:

```shell

> python -m 

> # or if you choose console_script to be True

> 

```

[1]: https://github.com/pwwang/pipen