lincc-frameworks / lincc-frameworks/python-project-template
Command line support in template
未关闭
还没有人认领这个 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.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 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