Metadata-Version: 2.4
Name: pipen-cli-init
Version: 1.1.2
Summary: A pipen cli plugin to create a pipen project (pipeline)
Author-email: pwwang <pwwang@pwwang.com>
License: MIT
Requires-Python: >=3.9
Requires-Dist: copier>=9
Requires-Dist: pipen>=1.1
Description-Content-Type: text/markdown

# 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
> uv sync
> # run the pipeline
> uv run python -m <pipeline_name>
> # or if you choose console_script to be True
> uv run <pipeline_name>
```

If you want to publish the pipeline:

```shell
uv build
uv publish
```

Then you can install it and run the pipeline globally:

```shell
> python -m <pipeline_name>
> # or if you choose console_script to be True
> <pipeline_name>
```

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