Metadata-Version: 2.1
Name: pipen-args
Version: 0.1.8
Summary: Command-line argument parser for pipen.
Home-page: https://github.com/pwwang/pipen-args
License: MIT
Author: pwwang
Author-email: pwwang@pwwang.com
Requires-Python: >=3.7.1,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: diot
Requires-Dist: pipen
Requires-Dist: pyparam (>=0.4.15,<0.5.0)
Project-URL: Repository, https://github.com/pwwang/pipen-args
Description-Content-Type: text/markdown

# pipen-args

Command line argument parser for [pipen][1]

## Usage
```python
from pipen import Proc, Pipen
from pipen_args import args

class Process(Proc):
    input = 'a'
    input_data = range(10)
    script = 'echo {{in.a}}'

Pipen().set_start(Process).run()
```

```
❯ python example.py --help

DESCRIPTION:
  Pipeline description.
  My process

USAGE:
  example.py --in.a list [OPTIONS]

OPTIONS FOR <Process>:
  --in.a <list>                   - [Required] Undescribed.

OPTIONAL OPTIONS:
  --config <path>                 - Read options from a configuration file in TOML. Default: None
  -h, --help                      - Print help information for this command
  --full                          - Show full options for this command

PIPELINE OPTIONS:
  --profile <str>                 - The default profile from the configuration to run the pipeline.
                                    This profile will be used unless a profile is specified in the
                                    process or in the .run method of pipen. Default: default
  --outdir <path>                 - The output directory of the pipeline
                                    Default:
                                    /home/pwwang/github/pipen-args/examples/pipen-0_results
  --workdir <str>                 - The workdir for the pipeline. Default: ./.pipen
  --scheduler <str>               - The scheduler to run the jobs. Default: local
```

See more examples in `examples/` folder.

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

