openapi-generators / openapi-generators/openapi-python-client

Calling the generator from cli works with different syntax from documentation

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

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

主要言語
Python
スター
2k
フォーク
293
平均マージ
34分
マージ済み PR(30日)
1

説明

Describe the bug

Calling from cli using the suggested method with python -m does not work.

python -m openapi-python-client --version
PATH_TO_PYTHON\python.exe: No module named openapi-python-client

Using underscores, however, does work (python -m openapi_python_client -version):

python -m openapi_python_client --version
openapi-python-client version: 0.24.3

OpenAPI Spec File

Not applicable

Desktop (please complete the following information):

  • OS: Windows 11 (Microsoft Windows NT 10.0.26100.0)
  • Python Version: [e.g. 3.12.7]
  • openapi-python-client version [e.g. 0.24.3]

Additional context

Running from a powershell instance in VSCode with a conda environment selected as a Python interpreter.

Would it be possible to add a line to the documentation mentioning the call with python -m?

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

issue でリンクされている README の箇所から始め、そこに記載された python -m の呼び出しと、報告で示されている動作するアンダースコア形式を比較します。プロジェクトの CLI コンテキストでコマンドを検証し、その後、サポートされている呼び出しが明示的かつ一貫したものになるようドキュメントを更新します。README のコマンドに従って新人が正常に実行できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
cli, documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
58/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。