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

Command line support in template

オープン
#561 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Jinja
スター
85
フォーク
16
平均マージ
6時間 18分
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. 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 を短くまとめたダイジェスト。