lincc-frameworks / lincc-frameworks/python-project-template

Command line support in template

未關閉
#561 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
Jinja
星號
85
分支
16
平均合併
6 小時 18 分鐘
30 天內合併 PR
1

描述

Add question for adding a command line interface

Will add to the pyproject.toml:

```
[project.scripts]
hyrax = "hyrax_cli.main:main"
```

Create some CLI entry point
* e.g. /src/hyrax_cli/main.py
* has all of the bits for a main method, and basic argparsing (and version printing).

Additional documentation:
* how to make a CLI for do_thing input_file output_file
* how to create config files, to trim the number of CLI arguments.

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從範本的 pyproject.toml 和建議的進入點 src/hyrax_cli/main.py 開始。加入 hyrax 主控台指令碼、基本引數解析、版本列印,以及關於 do_thing input_file output_file CLI 和設定檔的文件。當產生的專案提供可正常運作的 CLI,並說明如何使用及設定它時,即視為完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
cli, documentation
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。